Skip to content

SPECIFICATION.md

Latest commit

 

History

History
114 lines (95 loc) · 6.72 KB

SPECIFICATION.md

File metadata and controls

114 lines (95 loc) · 6.72 KB
Raw

ProteinDF プロジェクト GitHub Pages リニューアル仕様書

1. 概要とリニューアル目的

  • プロジェクト名: ProteinDF (All-Electron Quantum Chemistry Calculation Package for Proteins)
  • 対象リポジトリ: ProteinDF/ProteinDF.github.io
  • 目的:
    • 約10年前の旧式Jekyllサイトから、現代的・洗練されたオープンソース科学計算ポータルサイトへ刷新する。
    • プロジェクト全体のハブ（各ツールへの誘導、外部マニュアルへのリンク、原著論文および活用研究論文リスト）としての役割を強化する。
    • 英語・日本語のシームレスな多言語切り替え（i18n）を提供する。

2. 技術スタック・アーキテクチャ

項目 選定技術 / 仕様 備考
静的サイトジェネレーター Material for MkDocs (Python) 科学計算系OSSで標準的、高速・高品質
多言語化プラグイン mkdocs-static-i18n[material] 日英（EN / JA）切り替え、言語スイッチャー
マークダウン拡張 pymdown-extensions 数式 (Arithmatex/MathJax/KaTeX), タブ, コールアウト, カードグリッド
ホスティング & 自動公開 GitHub Pages + GitHub Actions main ブランチ push 時に自動ビルド＆デプロイ
開発言語環境 Python 3.9+ pip install -r requirements.txt

3. UI/UX・デザイン仕様

3.1 カラースキーム & テーマ

  • プライマリカラー: インディゴ / ディープスレート（科学的・学術的な信頼感）
  • アクセントカラー: シアン / エメラルド（計算科学・先進性）
  • ダークモード / ライトモード:
    • ヘッダーのトグルボタンまたはOS設定による自動切り替え
    • ダークモード時はコードブロックやカード枠に洗練されたハイライトを適用

3.2 多言語（i18n）設計

  • デフォルト言語: 英語 (en)
  • 対応言語: 英語 (en), 日本語 (ja)
  • URL構造:
    • 英語（デフォルト）: https://proteindf.github.io/ (各ページ例: /ecosystem/)
    • 日本語: https://proteindf.github.io/ja/ (各ページ例: /ja/ecosystem/)
  • 言語セレクター: ヘッダー右上に「🌐 English / 日本語」ドロップダウンを常設。同一ページの他言語版へワンクリックで遷移。

3.3 コンポーネント・UIパーツ

  1. ヒーローセクション: ロゴ、キャッチコピー、主要ボタングループ（Ecosystem / Manual / GitHub）
  2. グリッドカードUI: 各関連ツール（ProteinDF, QCLObot, pytools, bridge）の概要・GitHubリンク・マニュアルリンク
  3. BibTeX引用カード: 論文情報に加え、ワンクリックでコピー可能なBibTeXコードブロック
  4. クイック検索: Ctrl + K（Mac: Cmd + K）で全文検索モーダルを起動

4. ディレクトリ構成仕様

ProteinDF.github.io/
├── .github/
│   └── workflows/
│       └── deploy.yml              # GitHub Actions 自動デプロイワークフロー
├── docs/                           # コンテンツソースディレクトリ
│   ├── assets/
│   │   ├── images/
│   │   │   └── PDFLOGO.jpg         # プロジェクトロゴ
│   │   └── stylesheets/
│   │       └── extra.css           # カスタムスタイル（カード、ボタンスタイル等）
│   ├── index.en.md                 # トップページ（英語）
│   ├── index.ja.md                 # トップページ（日本語）
│   ├── ecosystem.en.md             # 関連ツール・エコシステム（英語）
│   ├── ecosystem.ja.md             # 関連ツール・エコシステム（日本語）
│   ├── publications.en.md          # 論文・引用（英語）
│   ├── publications.ja.md          # 論文・引用（日本語）
│   ├── community.en.md             # コミュニティ・連絡先（英語）
│   └── community.ja.md             # コミュニティ・連絡先（日本語）
├── mkdocs.yml                      # MkDocs 基本設定 & i18n設定
├── requirements.txt                # Python 依存パッケージ定義
├── SPECIFICATION.md                # 本仕様書
├── PROCEDURES.md                   # 開発・手順書
└── TODO.md                         # 実装TODOリスト

5. 各ページの構成 & 掲載データ定義

5.1 ホーム (index.en.md / index.ja.md)

  1. Hero: ロゴ、キャッチフレーズ、主要アクションボタン
  2. What is ProteinDF: 全電子DFT計算、QCLO法などの特徴説明
  3. Quick Access: 4つのツールカード（GitHubリンク、マニュアルリンク）
  4. News & Updates: 最新のお知らせ・更新情報

5.2 エコシステム・関連ツール (ecosystem.en.md / ecosystem.ja.md)

各ツールをカード形式で整理し、詳細説明・リポジトリリンク・マニュアルリンクを提供：

  • ProteinDF: コア超並列全電子DFT計算プログラム
    • Repository: https://github.com/ProteinDF/ProteinDF
    • Manual: http://proteindf.github.io/ProteinDF_userman/
  • QCLObot: QCLO法によるSCF収束自動化・ワークフロー支援ツール
    • Repository: https://github.com/ProteinDF/QCLObot
    • Manual: http://proteindf.github.io/QCLObot/
  • ProteinDF_pytools: 計算結果の可視化・データ解析用Pythonツール群
    • Repository: https://github.com/ProteinDF/ProteinDF_pytools
  • ProteinDF_bridge: 他の量子化学・モデリングソフトウェアとの連携インターフェース
    • Repository: https://github.com/ProteinDF/ProteinDF_bridge

5.3 論文・引用 (publications.en.md / publications.ja.md)

  1. Primary Citations (原著論文・計7本):
    • ProteinDF 開発論文（1997年〜2014年 計5本）
    • QCLO法 論文（2003年、2007年 計2本）
    • 各論文に BibTeX ワンクリックコピー用ブロックを完備
  2. References using ProteinDF (活用研究論文リスト・計24本):
    • 2005年〜2022年の主要成果（SARS-CoV-2、PETase、インスリン、グルコースオキシダーゼ等）を年別リスト化

5.4 コミュニティ・連絡先 (community.en.md / community.ja.md)

  • License: GNU General Public License v3.0 (GPLv3)
  • GitHub Organization: https://github.com/ProteinDF
  • Bug Reports & Feature Requests: GitHub Issues への案内
  • Contact / Contribution: 開発参加方法および連絡先