Skip to content

Commit

Permalink
using conda for virtual environments but put mamba as alternative (#59)
Browse files Browse the repository at this point in the history
  • Loading branch information
mxochicale committed Jul 14, 2023
1 parent b3e532c commit b543b0b
Showing 1 changed file with 7 additions and 18 deletions.
25 changes: 7 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,12 +75,13 @@ Whilst every effort has been made to automate tasks where possible, it is up to
How to use
~~~~~~~~~~

1. Install `Cookiecutter`_ using virtual environments in `mambaforce`_
1. Install `Cookiecutter`_ package and other requirements using virtual environments (VE) in `conda`_.
Similarly, you can install your VE using `mambaforce`_ by replacing conda with mamba.

::

mamba create -n ssptVE python=3.8 pip -c conda-forge
mamba activate ssptVE
conda create -n ssptVE python=3.8 pip -c conda-forge
conda activate ssptVE
pip install -r requirements-dev.txt


Expand Down Expand Up @@ -114,20 +115,7 @@ Note: make sure you use "git add ." not "git add * " to pick up hidden files lik

7. If using GitHub or WeissLAb, and assuming your URLs are all correct, GitHub Actions/GitLab CI should automatically run tests for your project.

8. (**Optional**) Create a virtual environment.

For an introduction to virtual environments, see https://realpython.com/python-virtual-environments-a-primer/.

If you do use a virtual environment, ensure that your virtual_envs folder is not inside MyNewProject.

::

mkdir virtual_envs
cd virtual_envs
virtualenv -p python3 mynewproject_virtualenv
source mynewproject_virtualenv/bin/activate

9. You can verify your project has been set up correctly by installing and running tox.
8. You can verify your project has been set up correctly by installing and running tox.

::

Expand Down Expand Up @@ -244,4 +232,5 @@ Supported by `Wellcome`_ and `EPSRC`_.
.. _`Cookiecutter`: https://cookiecutter.readthedocs.io
.. _`WEISSLab`: https://weisslab.cs.ucl.ac.uk/
.. _`ReadTheDocs`: https://readthedocs.org/
.. _`mambaforce`: https://github.com/conda-forge/miniforge#install
.. _`mambaforce`: https://github.com/conda-forge/miniforge#install
.. _`conda`: https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html

0 comments on commit b543b0b

Please sign in to comment.