diff --git a/binder/Dockerfile b/binder/Dockerfile index fc24563..1a97c8c 100644 --- a/binder/Dockerfile +++ b/binder/Dockerfile @@ -1,2 +1,2 @@ ### DO NOT EDIT THIS FILE! This Is Automatically Generated And Will Be Overwritten ### -FROM ghcr.io/mrchemsoft/vampyr-coven:ec0227a8dcdc \ No newline at end of file +FROM ghcr.io/bjorgve/vampyr-coven:63a2115f8e3a \ No newline at end of file diff --git a/content/conf.py b/content/conf.py index 000bd7d..53e48a0 100644 --- a/content/conf.py +++ b/content/conf.py @@ -81,7 +81,7 @@ # a list of builtin themes. # html_theme = "sphinx_book_theme" -html_logo = "img/hylleraas-logo.png" +html_logo = "img/vampyr-logo.png" html_title = "" # project html_js_files = [ "https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js", @@ -102,4 +102,4 @@ "thebe": True, "notebook_interface": "jupyterlab", }, -} \ No newline at end of file +} diff --git a/content/img/hylleraas-logo.png b/content/img/hylleraas-logo.png deleted file mode 100644 index a2ea8fe..0000000 Binary files a/content/img/hylleraas-logo.png and /dev/null differ diff --git a/content/img/mrchem-logo.png b/content/img/mrchem-logo.png deleted file mode 100644 index 97ba5f3..0000000 Binary files a/content/img/mrchem-logo.png and /dev/null differ diff --git a/content/index.rst b/content/index.rst index 7e70609..226d759 100644 --- a/content/index.rst +++ b/content/index.rst @@ -1,8 +1,9 @@ VAMPyR coven ===================== -This is a collection of notebooks for VAMPyR. +This is a collection of notebooks for VAMPyR, the Very Accurate Multiresolution Python Routines library. The repository holds Jupyter notebooks that demonstrate the use of VAMPyR for various scientific computations and simulations. +The setup notebook provides instructions for installing and configuring the VAMPyR library and its dependencies, ensuring the environment is prepared for all subsequent simulations. .. toctree:: :hidden: @@ -10,11 +11,18 @@ This is a collection of notebooks for VAMPyR. setup +The demos include: + +- The beryllium atom notebook, where users can learn about quantum mechanical modeling of the beryllium atom, including setting up the atomic structure, calculating energy levels, and visualizing electron orbitals using VAMPyR. +- The harmonic oscillator evolution notebook guides users through the simulation of the time evolution of a quantum harmonic oscillator, demonstrating the use of VAMPyR to solve the Schrödinger equation and analyze system dynamics. +- The PCMSolvent notebook focuses on the application of the Polarizable Continuum Model (PCM) for simulating solvent effects. It shows how VAMPyR can be used to model the influence of a solvent as a polarizable continuum on a solute molecule. + +These notebooks can be run directly in the browser for convenience, but for those who prefer or require local execution, it is also possible to download the repository and run the notebooks on one's own machine. .. toctree:: :hidden: :maxdepth: 1 - :caption: Exercises + :caption: Demos notebooks/beryllium_atom notebooks/harmonic_oscillator_evolution diff --git a/content/setup.rst b/content/setup.rst index 9f04f70..7d76eb0 100644 --- a/content/setup.rst +++ b/content/setup.rst @@ -3,76 +3,17 @@ Setting up your system ====================== -In order to follow this workshop, you will need access to the VAMPyR python -package and the MRChem program. +To use the VAMPyR Python package, you have two main options: working online or setting up your local environment. -You can work on the VAMPyR content entirely online using `Binder `_ -to run the Jupyter notebooks in the cloud, but some of the MRChem exercises are best -performed on a HPC cluster. +For online access, `Binder `_ allows you to run the Jupyter notebooks in the cloud without any local setup. -If you prefer to work locally, you will need to set up your Python environment correctly: -we recommend using the `Conda package and enviroment manager -`_, as it provides a convenient way to install -binary packages, including VAMPyR and MRChem, in an isolated, reproducible software -environment. +For local use, setting up your Python environment correctly is crucial. The `Conda package and environment manager `_ is recommended for installing binary packages, including VAMPyR, in an isolated and reproducible software environment. -Please refer to the respective GitHub repositories for different ways of installing: +For installation instructions, please refer to the VAMPyR GitHub repository: - `VAMPyR `_ -- `MRChem `_ - Install Miniconda ^^^^^^^^^^^^^^^^^ -Follow the official `Miniconda -`_ installation instructions -for your platform: - -- For Linux see https://docs.conda.io/en/latest/miniconda.html#linux-installers -- For macOS see https://docs.conda.io/en/latest/miniconda.html#macosx-installers -- For Windows see https://docs.conda.io/en/latest/miniconda.html#windows-installers - -For all platforms, make sure to select the **Python 3.8**, **64 bit** installer. - - -Cloning the vampyr coven repository -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you want to run the exercise notebooks locally on your laptop, then you can -clone our tutorial repository. We provide a conda environment -complete with all the things you need to run the notebooks. - -Clone the repostory with:: - - $ git clone https://github.com/MRChemSoft/vampyr-coven.git - -Then move into this repository:: - - $ cd vampyr-coven - -To create the environment, use the instructions in the next section. -Finally, launch a `Jupyter lab` instance with:: - - $ jupyter lab - -This should open up a new tab in your default browser. -The notebooks can be found in `content/notebooks`. - -Creating an environment and installing packages -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -Once you have ``conda`` installed and correctly configured you can use the -:download:`environment.yml <../environment.yml>` file to install the -dependencies. First save it to your hard drive by clicking the link, and then -in a terminal (Anaconda Prompt on Windows) navigate to where you saved the file -and type:: - - $ conda env create -f environment.yml - - -You then need to activate the new environment by:: - - $ conda activate vampyr-coven - - -Now you should have VAMPyR, MRChem, Python, JupyterLab and a few other packages installed! +To install Miniconda, follow the official `Miniconda installation instructions `_.