[install] Add conda environment.yml (asteroid-team#354)

Co-authored-by: Milos Cernak <mcernak@logitech.com> Co-authored-by: mpariente <pariente.mnl@gmail.com>
sreyareddy15 · Nov 25, 2020 · 8333675 · 8333675
1 parent 9b46579
commit 8333675
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 7 deletions.
diff --git a/README.md b/README.md
@@ -48,22 +48,29 @@ so hop on and help us!
 
 ## Installation
 ([↑up to contents](#contents))
-In order to install Asteroid, clone the repo and install it using
-pip or python :
+To install Asteroid, clone the repo and install it using
+conda, pip or python :
 ```bash
+# First clone and enter the repo
 git clone https://github.com/mpariente/asteroid
 cd asteroid
-# Install install-required deps
-pip install numpy Cython
+```
+
+- With `pip`
+```bash
 # Install with pip in editable mode
 pip install -e .
 # Or, install with python in dev mode
 # python setup.py develop
 ```
-Asteroid is also on PyPI, you can install the latest release
-with
+- With conda (if you don't already have conda, see [here][miniconda].)
+```bash
+conda env create -f environment.yml
+conda activate asteroid
+```
+
+- Asteroid is also on PyPI, you can install the latest release with
 ```bash
-pip install numpy Cython
 pip install asteroid
 ```
 
@@ -192,6 +199,7 @@ If you loved using Asteroid and you want to cite us, use this :
 ```
 
 [comment]: <> (Badge)
+[miniconda]: https://conda.io/miniconda.html
 [travis]: https://travis-ci.com/mpariente/asteroid
 [travis-badge]: https://travis-ci.com/mpariente/asteroid.svg?branch=master
 [codecov-badge]: https://codecov.io/gh/mpariente/asteroid/branch/master/graph/badge.svg

diff --git a/docs/source/installation.rst b/docs/source/installation.rst
@@ -31,3 +31,5 @@ For development installation, you can fork/clone the GitHub repo and locally ins
 
 This is an editable install (``-e`` flag), it means that source code changes (or branch switching) are
 automatically taken into account when importing asteroid.
+
+You can also use ``conda env create -f environment.yml`` to create a Conda env directly.
diff --git a/environment.yml b/environment.yml
@@ -0,0 +1,10 @@
+name: asteroid
+channels:
+  - anaconda
+  - conda-forge
+dependencies:
+  - python=3.8
+  - Cython
+  - pip:
+    - -r file:requirements.txt
+    - -e .
Original file line number	Diff line number	Diff line change
Expand Up		@@ -31,3 +31,5 @@ For development installation, you can fork/clone the GitHub repo and locally ins

		This is an editable install (``-e`` flag), it means that source code changes (or branch switching) are
		automatically taken into account when importing asteroid.

		You can also use ``conda env create -f environment.yml`` to create a Conda env directly.