From b5b6aee7a54bff651d1db52a9ea125b7399fd88e Mon Sep 17 00:00:00 2001 From: bgeels <bgeels@usgs.gov> Date: Thu, 21 Dec 2023 14:16:15 -0700 Subject: [PATCH] Apply suggested changes to install.md --- docs/install.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/docs/install.md b/docs/install.md index 34fdfb9e..bdfffd25 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,6 +1,6 @@ # Installation This document describes installation instructions for users. For those that wish to modify or develop custom code within **geomag-algorithms**, or prefer to install the Docker container, please see the following documents: -> - [Develop](./develop.md) provides installation instruction for developers +> - [Develop](./develop.md) provides installation instruction for developers. > - [Docker](./install_docker.md) describes Docker container installation and usage. ## Requirements @@ -15,29 +15,29 @@ This document describes installation instructions for users. For those that wish ```bash conda create --name=geomagenv --channel conda-forge python=3 obspy pycurl -source activate geomagenv``` - +source activate geomagenv +``` 2. Install **geomagio** - - pip install git+https://code.usgs.gov/ghsc/geomag/geomag-algorithms.git +```bash +pip install git+https://code.usgs.gov/ghsc/geomag/geomag-algorithms.git +``` ### Option 2: Venv and pip 1. Create a virtual environment using `venv` (recommended) - python -m venv path/to/your/environment - - > `venv` is a tool included with Python 3.3 and above that allows you to create isolated Python environments, each with their own set of installed packages, which can help you manage different projects without package conflicts. Each environment is stored within a folder of the user's choosing. - > - > You can find more information on using `venv` [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). +```bash +python -m venv path/to/your/environment +``` +> `venv` is a tool included with Python 3.3 and above that allows you to create isolated Python environments, each with their own set of installed packages, which can help you manage different projects without package conflicts. Each environment is stored within a folder of the user's choosing. +> +> You can find more information on using `venv` [here](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment). 2. Install **geomagio** within the virtual environment - source path/to/your/environment/bin/activate - pip install git+https://code.usgs.gov/ghsc/geomag/geomag-algorithms.git - -## Using **geomagio** -**geomagio** is the Python module for interfacing with geomag-algorithms. +```bash +source path/to/your/environment/bin/activate +pip install git+https://code.usgs.gov/ghsc/geomag/geomag-algorithms.git +``` - - In Python scripts or Jupyter notebooks use `import geomagio` - - Use the main script, `geomag.py -h` \ No newline at end of file +>*Note:* **geomagio** is the Python module for interfacing with geomag-algorithms. -- GitLab