From 1d227ae084de3aab112b78677bdc0f009cbd9ca5 Mon Sep 17 00:00:00 2001 From: Ross Whitfield Date: Wed, 24 Feb 2021 14:41:39 -0500 Subject: [PATCH] Updating install information --- README.md | 2 +- doc/examples/helloworld/setup.py | 2 +- doc/user_guides/component_package.rst | 11 +++++------ doc/user_guides/nersc_conda.rst | 7 +++++++ 4 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 773be936..142aa00f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Integrated Plasma Simulator (IPS) Framework -The documentation can be found at +The documentation can be found at https://ips-framework.readthedocs.io Installation is available via pip: diff --git a/doc/examples/helloworld/setup.py b/doc/examples/helloworld/setup.py index f7d9a17b..f53bcb1a 100644 --- a/doc/examples/helloworld/setup.py +++ b/doc/examples/helloworld/setup.py @@ -4,6 +4,6 @@ setup( name="helloworld", version="1.0.0", - install_requires=["ipsframework==0.2.1"], + install_requires=["ipsframework"], packages=find_packages(), ) diff --git a/doc/user_guides/component_package.rst b/doc/user_guides/component_package.rst index 6577f226..e4038042 100644 --- a/doc/user_guides/component_package.rst +++ b/doc/user_guides/component_package.rst @@ -6,20 +6,19 @@ package. This is also an example of using ``MODULE`` instead of ``SCRIPT`` in the component configuration section. The examples will be a simple hello world with one driver and one -worker. The only requirement of the package is ``ipsframework`` and we -are using the specific version v0.2.1. The ipsframework should be -automatically installed from pypi when install ipsexamples but you can -manually install it from pypi with +worker. The only requirement of the package is ``ipsframework``. The +ipsframework should be automatically installed from pypi when install +ipsexamples but you can manually install it from pypi with .. code-block:: bash - python -m pip install ipsframework==0.2.1 + python -m pip install ipsframework Or to install it directly from github you can do .. code-block:: bash - python -m pip install git+https://github.com/HPC-SimTools/IPS-framework.git@v0.2.1 + python -m pip install git+https://github.com/HPC-SimTools/IPS-framework.git To create this project locally, create the following file structure diff --git a/doc/user_guides/nersc_conda.rst b/doc/user_guides/nersc_conda.rst index a65bb9fe..becb7d01 100644 --- a/doc/user_guides/nersc_conda.rst +++ b/doc/user_guides/nersc_conda.rst @@ -6,6 +6,11 @@ NERSC recommends the use of anaconda environments to mange python installs, see `Brief introduction to Python at NERSC `_. +There is a conda environment already constructed and maintained for +the *atom* project created using the `shareable environment`_ +method. You can activate it by running ``source +/global/common/software/atom/cori/ips-framework-new/bin/activate``. + Creating you own conda environment ---------------------------------- @@ -53,6 +58,8 @@ environment to run use, see `Running Python in a batch job source activate my_ips_env ips.py --config=simulation.config --platform=platform.conf +.. _shareable environment: + Creating a shareable environment on /global/common/software -----------------------------------------------------------