Merge pull request #1 from kousuke-nakano/main

Transfer the old website

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+# These owners are the default owners for everything in
+# the repo. Unless a later match takes precedence,
+* @kousuke-nakano
+
+# @kousuke-nakano owns any files in the build/ directory at 
+# the root of the repository and any of its subdirectories.
+# /doc/ @kousuke-nakano

.github/workflows/website-deploy.yml

@@ -0,0 +1,33 @@
+# This workflow will deploy the sphinx document.
+
+name: sphinx-deploy-gh-pages
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  sphinx-build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install and Setup Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.8
+
+    - name: Install python dependencies
+      run: pip install sphinx sphinx-rtd-theme
+
+    - name: Checkout the project repository
+      uses: actions/checkout@v2
+
+    - name: Build the sphinx document.
+      #working-directory: doc
+      run: |
+        make html
+
+    - name: Deploy the sphinx document.
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: build/html

.github/workflows/website-sphinx-build-test.yml

@@ -0,0 +1,30 @@
+# This workflow will deploy the sphinx document.
+
+name: sphinx-build-test
+
+on:
+  push:
+    branches: [ "main", "devel" ]
+  pull_request:
+    branches: [ "main", "devel" ]
+
+jobs:
+  sphinx-build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Install and Setup Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: 3.8
+
+    - name: Install python dependencies
+      run: pip install sphinx sphinx-rtd-theme
+
+    - name: Checkout the project repository
+      uses: actions/checkout@v2
+
+    - name: Build the sphinx document.
+      #working-directory: doc
+      run: |
+        make html
+

Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = turborvb-website
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

README.md

@@ -1 +1,34 @@
-# turborvb_website
+TurboRVB website:
+--------------------------------------
+
+Source codes of our TurboRVB website. **Please do not include any confidential information because the source files are also public.**
+
+The html (build) files in the master branch are uploaded to the SISSA server (i.e., public).
+
+How to edit the website::
+
+This document is composed by Sphinx, which is a documentation generator. i.e, it takes plain-text source files, and then generates HTML files. You can think of it as a program that takes plain-text files written in the ``reStructuredText`` format and outputs HTML::
+
+    reStructuredText -> via Sphinx -> HTML
+
+Therefore, you should be minimally familiar with ``reStructuredText``.
+
+Sphinx is coded based on python (but you do not need to familiarize yourself with python itself!). So, first you should install the sphinx modules using via pip::
+
+    pip install Sphinx
+    pip install sphinx_rtd_theme
+
+The document can be built just by typing::
+
+    make html
+
+in the root directory (i.e., TurboRVB_website/). The generated documents are put in::
+
+     html version : root -> build -> html -> index.html, etc...
+
+The source files (i.e., xxx.rst) are:
+
+     rst files: root -> source -> index.rst,   root -> source -> _sources -> ***.rst
+
+Note: The public and development branches are no longer used (will be deleted).
+

source/_sources/02Developers.rst

@@ -0,0 +1,149 @@
+.. TurboRVB_manual documentation master file, created by
+   sphinx-quickstart on Thu Jan 24 00:11:17 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Developers and Contributors
+===========================================
+
+Main developer
+-------------------------------------------
+
+Dr. Sandro Sorella
+#########################
+
+.. figure:: /_static/01photos/ss.jpg
+   :height: 150px
+
++ `Personal website <https://people.sissa.it/~sorella/>`__
++ **International School for Advanced Studies (SISSA), Italy**
+
+Project PIs
+-------------------------------------------
+
+Dr. Michele Casula
+###################################
+
+.. figure:: /_static/01photos/mc.jpg
+    :height: 150px
+
++ `Personal website <http://www-ext.impmc.upmc.fr/~casula/>`__
++ **Sorbonne Universit´e, CNRS, France**
+
+Dr. Kosuke Nakano
+###################################
+
+.. figure:: /_static/01photos/kn.jpg
+    :height: 150px
+
++ `Personal website <https://www.kosuke-nakano-research.info>`__
++ **International School for Advanced Studies (SISSA), Italy**
++ **Japan Advanced Institute of Science and Technology (JAIST), Japan**
+
+Contributors (alphabetic order)
+-------------------------------------------
+
+Dr. Claudio Attaccalite
+###################################
+
+.. figure:: /_static/01photos/cc.jpg
+    :height: 150px
+
++ `Personal website <http://www.attaccalite.com>`__
++ **Aix-Marseille Universit´e, CNRS, France**
+
+Dr. Matteo Barborini
+###################################
+
+.. figure:: /_static/01photos/an.jpg
+    :height: 100px
+
++ **CNR-NANO, Italy**
+
+Dr. Andrea Tirelli
+###################################
+
+.. figure:: /_static/01photos/at.jpg
+    :height: 150px
+
++ `Personal website <https://people.sissa.it/~atirelli/>`__
++ **International School for Advanced Studies (SISSA), Italy**
+
+Mr. Giacomo Tenti
+###################################
+
+.. figure:: /_static/01photos/gt.jpg
+    :height: 150px
+
++ **International School for Advanced Studies (SISSA), Italy**
+
+Dr. Luca Capriotti
+###################################
+
+.. figure:: /_static/01photos/an.jpg
+    :height: 100px
+
++ **New York University, United States of America**
++ **University College London, United Kingdom**
+
+Dr. Emanuele Coccia
+###################################
+
+.. figure:: /_static/01photos/ec.jpg
+    :height: 150px
+
++ **University of Trieste, Italy**
+
+Dr. Mario Dagrada
+###################################
+
+.. figure:: /_static/01photos/md.jpg
+    :height: 150px
+
++ `Personal website <https://madagra.github.io>`__
++ **Forescout Technologies, The Netherlands**
+
+Dr. Claudio Genovese
+###################################
+
+.. figure:: /_static/01photos/an.jpg
+    :height: 100px
+
++ **International School for Advanced Studies (SISSA), Italy**
+
+Dr. Oto Kohulák
+###################################
+
+.. figure:: /_static/01photos/ok.jpg
+    :height: 150px
+
++ **International School for Advanced Studies (SISSA), Italy**
+
+Dr. Ye Luo
+###################################
+
+.. figure:: /_static/01photos/an.jpg
+    :height: 100px
+
++ **Argonne National Laboratory, United States of America**
+
+Dr. Guglielmo Mazzola
+###################################
+
+.. figure:: /_static/01photos/an.jpg
+    :height: 100px
+
++ **University of Zurich, Switzerland**
+
+Dr. Andrea Zen
+###################################
+
+.. figure:: /_static/01photos/az.jpg
+    :height: 150px
+
++ **University College London, United Kingdom**
+
+..
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`

source/_sources/03Source_code.rst

@@ -0,0 +1,39 @@
+.. TurboRVB_website documentation master file, created by
+   sphinx-quickstart on Thu Jan 24 00:11:17 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Source codes
+===========================================
+
+When you publish a paper using our code(s), please cite corresponding paper(s).
+
+- | `TurboRVB: a many-body toolkit for ab initio electronic simulations by quantum Monte Carlo <https://doi.org/10.1063/5.0005037>`_
+  | K. Nakano*, C. Attaccalite, M. Barborini, L. Capriotti, M. Casula*, E. Coccia, M. Dagrada, Y. Luo, G. Mazzola, A. Zen, and S. Sorella*, 
+  | *J. Chem. Phys.* 152, 204121 (2020)
+    
+- | Turbo-Genius: A Python suite implementing workflows of the ab-initio quantum Monte Carlo calculations
+  | K. Nakano*, et al.
+  | *In preparation* (2023).
+
+
+TurboRVB
+----------------------------------
+**TurboRVB** is an open-source project. The source code is available from the `GitHub repository <https://github.com/sissaschool/turborvb>`__.
+
+TurboGenius
+----------------------------------
+**TurboGenius** is an open-source project. The source code is available from the `GitHub repository <https://github.com/kousuke-nakano/turbogenius>`__.
+
+TurboWorkflows
+----------------------------------
+**TurboWorkflows** is an open-source project. The source code is available from the `GitHub repository <https://github.com/kousuke-nakano/turboworkflows>`__.
+
+Tutorials
+----------------------------------
+Tutorials are available from the `GitHub Pages <https://kousuke-nakano.github.io/turbotutorials/>`__.
+
+..
+    * :ref:`genindex`
+    * :ref:`modindex`
+    * :ref:`search`