diff --git a/README.md b/README.md index 449ad48e4069ce1033ec5f8b7e13e0113e7ddffb..9e4f09581fe7f520cfa19c145fb0754b2d5e85b8 100644 --- a/README.md +++ b/README.md @@ -73,12 +73,26 @@ conda install -c conda-forge pip pip install psimpy ``` -Now you should have `PSimPy` and its dependencies successfully installed. +Now you should have `PSimPy` and its dependencies successfully installed in your +conda environment. You can use it in the Python terminal or in your Python IDE. + +If you would like to use it with Jupyter Notebook (iPython Notebook), there is +one extra step needed to set your conda environment on your Notebook: + +6. Install `ipykernel` and install a kernel that points to your conda environment +by +```bash +conda install -c conda-forge ipykernel +python -m ipykernel install --user --name=your_env_name +``` + +Now you can start your Notebook, change the kernel to your conda environment, and +use `PSimPy`. ## Usage Examples are currently in preparation and will be available soon in coming versions. You may want to have a look at the tests which are currently available -at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how `PSimpy` +at https://git-ce.rwth-aachen.de/mbd/psimpy. They give a glimpse of how `PSimPy` can be used. You may download the `tests` folder onto your local machine, and run any test using `pytest`. @@ -97,10 +111,10 @@ or a specific test like `test_active_learning` by pytest tests/test_active_learning.py ``` Some tests save results including plots into temporary folders. The temporary -folders will be deleted automatically if `test_clear_temp_file` is called. If -you want to exclude a specific test such as `test_clear_temp_file`, you may run +folders will be deleted automatically if `test_clear_temp_files` is called. If +you want to exclude a specific test such as `test_clear_temp_files`, you may run ```bash -pytest tests/ --ignore=tests/test_clear_temp_file.py +pytest tests/ --ignore=tests/test_clear_temp_files.py ``` ## Documentation