xGEMS examples using Jupyter notebooks
Using Jupyter Lab Notebooks and Binder. This is just a demo and the work will be lost once you close your browser.
Wait until the Jupyter Lab Notebook server starts (~1 min) then double click on any how-to-... tutorial notebook.
More information on Jupyter Notebooks: Jupyter Documentation
Run Jupyter Notebooks examples/tutorials on jupyter notebook/lab running locally on your computer. First checkout this repository or simply click on code download zip.
For this you first need to have Miniforge or Miniconda installed (follow the instructions on their websites).
In the Linux/MacOS terminal or Windows miniconda/miniforge command prompt or terminal change to the directory jupyter (that you cloned from this repository) and execute the following commands:
conda env create -f environment.yml
conda activate xgems
First command will create the xgems conda environment congaing all the necessary libraries to run xGEMS and associated codes. The second command will activate the environment and your terminal line should show xgems.
To start jupyter lab in your terminal/command prompt navigate to the desired folder (preferably where you have the notebook files) and execute:
jupyter lab
This repository contains examples of uses cases and functionality of xGEMS. Additional information about the methods and data used in xGEMS you can find in the documentation or repository.
Start with how-to-use-xgems-examples.ipynb or look in the folder how-to-use-xgems-examples.