Rename /scripts and update CONTRIBUTING.md

CHANGELOG.md

@@ -1,3 +1,8 @@
+# Version 1.0.2
+- Rename /scripts directory to /recipe
+- Add additional channel to list of channels in eqt_env.yml
+- Update CONTRIBUTING.md with detailed installation instructions
+
 # Version 1.0.1
 - Add NoBorderScrollArea, example and tests (#155)
 - Edit next and prev in UIMultiStepWidget (#151)

CONTRIBUTING.md

@@ -2,12 +2,34 @@
 Contribute to the repository by opening a pull request.
 
 ## Local
-Develop code locally by cloning the source code and installing it.
+Develop code locally by cloning the source code, creating a development environment and installing it.
+
+1. Install [mamba](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html), then launch the `Miniforge Prompt`.
+
+2. Clone the `main` branch of `eqt` locally, and navigate into where it has been cloned:
 
 ```sh
 # Clone (download) source code
-git clone [email protected]:TomographicImaging/eqt
+git clone [email protected]:TomographicImaging/eqt.git
 cd eqt
+```
+
+3. Create the mamba environment using the following command:
+
+```sh
+# Create environment
+mamba env create -f recipe/eqt_env.yml
+```
+
+4. Activate the environment:
+
+```sh
+mamba activate eqt_env
+```
+
+5. Install the dependencies:
+
+```sh
 # Install test dependencies
 pip install .[dev]
 ```

scripts/eqt_env.yml → recipe/eqt_env.yml

@@ -1,9 +1,9 @@
-# This creates an environment with all of the prerequisites for eqt
 name: eqt_env
 channels:
   - conda-forge
+  - https://software.repos.intel.com/python/conda
 dependencies:
   - python
   - pip
   - pyside2
-  - qdarkstyle
+  - qdarkstyle