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:
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.
> - [Docker](./install_docker.md) describes Docker container installation and usage.
## Requirements
## Requirements
...
@@ -15,29 +15,29 @@ This document describes installation instructions for users. For those that wish
...
@@ -15,29 +15,29 @@ This document describes installation instructions for users. For those that wish
1. Create a virtual environment using `venv` (recommended)
1. Create a virtual environment using `venv` (recommended)
python -m venv path/to/your/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.
```
>
> `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).
>
> 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
2. Install **geomagio** within the virtual environment