Tutorial for FANS

.gitignore

@@ -205,3 +205,17 @@ test/input_files/**/*.json
 !test_LinearThermal.json
 !test_PseudoPlastic.json
 !test_J2Plasticity.json
+
+# AiiDA-FANS tutorial required files
+!tutorial_dataset.h5
+
+# AiiDA-FANS tutorial generated files
+configure_profile.yaml
+configure_computer.yaml
+configure_code.yaml
+.aiida_run
+
+# pixi
+.pixi
+pixi.lock
+*.egg-info

AiiDA-FANS/README.md

@@ -0,0 +1,59 @@
+# aiida-fans-tutorial
+Learn how to use aiida-fans in this marimo powered tutorial.
+
+## Usage
+
+Assuming you have FANS, python 3.13, venv, and pip installed on a linux system, the recommended way to use this tutorial is by creating a virtual environment in this directory with the following command:
+
+```
+python -m venv .venv
+```
+Then activate this environment like so:
+
+```
+source .venv/bin/activate
+```
+
+You can ensure the the environment was succesfully activated with `which python` and ultimately deactivate the environment with `deactivate` when you're finished.
+
+You may need to install/upgrade pip now with your virtual environment activated. Run the following command:
+
+```
+python -m pip install --upgrade pip
+```
+
+Once pip is up to date, run the following command to install the tutorial's dependencies:
+
+```
+python -m pip install -r requirements.txt
+```
+
+Now you are ready to launch the notebook and begin the tutorial. Run the following command and access the marimo notebook at the port provided:
+
+```
+marimo run tutorial.py
+```
+
+## Alternative Usage
+
+### 1. Conda
+
+> [!WARNING]  
+> This method is a work-in-progress!
+
+### 2. Pixi
+
+> [!WARNING]  
+> This method is a work-in-progress!
+
+You can use pixi to install everything you need as defined by the pyproject.toml file. It should bundle python, FANS, AiiDA, aiida-fans, and marimo all into a virtual environment located in a .pixi directory. You can proceed to directly begin the tutorial with:
+
+```
+marimo run tutorial.py
+```
+
+Activating the environment may look something like this:
+
+```
+pixi shell --manifest-path ~/FANS/tutorial/pyproject.toml
+```

AiiDA-FANS/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "aiida-fans-tutorial"
+description = "Learn how to use aiida-fans in this marimo powered tutorial."
+authors = [{name = "Ethan Shanahan", email = "ethan.shanahan@gmail.com"}]
+requires-python = ">= 3.12"
+version = "0.1.0"
+dependencies = []
+
+[build-system]
+build-backend = "hatchling.build"
+requires = ["hatchling"]
+
+[tool.pixi.project]
+channels = ["conda-forge"]
+platforms = ["linux-64"]
+
+[tool.pixi.dependencies]
+python = ">=3.12.10,<4"
+marimo = ">=0.13.0,<0.14"
+aiida-fans = ">=0.1.5,<0.2"
+fans = ">=0.3.0,<0.4"

AiiDA-FANS/requirements.txt

@@ -0,0 +1,2 @@
+aiida-fans==0.1.5
+marimo==0.13