Skip to content

Commit

Permalink
using mamba, minimal installer of conda in linux/osX/windows, to mana…
Browse files Browse the repository at this point in the history
…ge virtual envirohments (#59)
  • Loading branch information
mxochicale committed Jul 12, 2023
1 parent 9d3fa76 commit b3e532c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 7 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,13 @@ Whilst every effort has been made to automate tasks where possible, it is up to
How to use
~~~~~~~~~~

1. Install `Cookiecutter`_
1. Install `Cookiecutter`_ using virtual environments in `mambaforce`_

::

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


2. Run `Cookiecutter`_ with the URL of this template
Expand Down Expand Up @@ -242,3 +244,4 @@ 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
18 changes: 13 additions & 5 deletions {{cookiecutter.project_slug}}/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Author: {{ cookiecutter.full_name }}

{{ cookiecutter.project_name }} is part of the `SciKit-Surgery`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.

{{ cookiecutter.project_name }} is tested on Python 3.7 but should support other modern Python versions.
{{ cookiecutter.project_name }} is tested on Python 3.8 but should support other modern Python versions.

{{ cookiecutter.project_name }} is currently a demo project, which will add/multiply two numbers. Example usage:

Expand All @@ -49,12 +49,22 @@ You can clone the repository using the following command:
git clone {{ cookiecutter.project_url }}


Create virtual environment
^^^^^^^^^^^^^^^^^^^^^^^^^^

You can create a mamba virtual environment using

::

mamba create -n {{ cookiecutter.project_name }}VE python=3.8 pip -c conda-forge
mamba activate {{ cookiecutter.project_name }}VE
pip install -r requirements-dev.txt

Running tests
^^^^^^^^^^^^^
Pytest is used for running unit tests:
::

pip install pytest
python -m pytest


Expand All @@ -65,7 +75,6 @@ This code conforms to the PEP8 standard. Pylint can be used to analyse the code:

::

pip install pylint
pylint --rcfile=tests/pylintrc {{cookiecutter.pkg_name}}


Expand Down Expand Up @@ -114,5 +123,4 @@ Supported by `Wellcome`_ and `EPSRC`_.
.. _`Wellcome`: https://wellcome.ac.uk/
.. _`EPSRC`: https://www.epsrc.ac.uk/
.. _`contributing guidelines`: {{ cookiecutter.project_url }}/blob/master/CONTRIBUTING.rst
.. _`license file`: {{ cookiecutter.project_url }}/blob/master/LICENSE

.. _`license file`: {{ cookiecutter.project_url }}/blob/master/LICENSE

0 comments on commit b3e532c

Please sign in to comment.