Skip to content

Latest commit

 

History

History
20 lines (18 loc) · 1.85 KB

README.md

File metadata and controls

20 lines (18 loc) · 1.85 KB
Raw

Alfalfa Notebooks

The Alfalfa Notebooks repository is a collection of introductory jupyter notebooks for how to interact with an Alfalfa instance via the alfalfa-client python library.

Setup

  1. Download this repository and save it to a folder on your computer.
  2. Install poetry.
  3. Open your command line interface and navigate to this folder.
  4. Run poetry install (this project requires python 3.7+ to run)
  5. Run poetry run jupyter lab to launch JupyterLab or interact with notebooks in an editor (ex: VSCode) that supports Jupyter Notebooks natively.
  6. In the browser window with jupyter lab in it select the twobldgs.ipnb or the simple_run.ipynb file.
  7. If you are running the alfalfa server locally no changes are required. If not, change the the host in the second cell ('http://localhost' by default) to the url of your alfalfa server. (Trailing slashes in the URL can lead to errors. This will be fixed in the future but as of now it is still a bug)
  8. You can now run the contents of the notebook. (Note: the twobldgs.ipynb notebook runs two models simulaneously, this means your Alfalfa server will need at least two workers)

Installation Troubleshooting

Poetry is not using the correct version of Python

  1. Run poetry env list to list the current environments poetry has created
  2. If there is one with the incorrect version of python run poetry env remove {environment name}
  3. Run poetry env use 3.8 (replace 3.8 with whatever version of python 3.7 or higher you would like to use)
  4. If that fails you may need to make sure that you have that version of python installed and if using pyenv make sure it is configured correctly.
  5. Run poetry install hopefully with no problems this time