instructions

Author: tomvanmele

README.md

@@ -1,35 +1,26 @@
 # COMPAS Framework
 
-The COMPAS framework packages
+A "meta package" to install the COMPAS framework packages.
 
 ## Installation
 
-Stable releases can be installed from PyPI.
+For installation without `compas_occ`.
 
 ```bash
 pip install compas_framework
 ```
 
-To install the latest version for development, do:
+For installation with `compas_occ`.
 
 ```bash
-git clone https://github.com/compas-dev/compas_framework.git
-cd compas_framework
-pip install -e ".[dev]"
-```
-
-To install with support for Jupyter notebooks, do:
-
-```bash
-git clone https://github.com/compas-dev/compas_framework.git
-cd compas_framework
-pip install -e ".[notebook]"
+conda create -n compas-dev -c conda-forge compas_occ
+conda activate compas-dev
+pip install compas_framework
 ```
 
 ## Documentation
 
-For further "getting started" instructions, a tutorial, examples, and an API reference,
-please check out the online documentation here: [COMPAS Framework docs](https://compas-dev.github.io/compas_framework)
+For more information, check out the online documentation here: [COMPAS Framework docs](https://compas.dev/compas_framework)
 
 ## Issue Tracker
 

docs/index.rst

@@ -4,11 +4,7 @@ compas_framework
 
 .. rst-class:: lead
 
-The COMPAS framework packages
-
-.. .. figure:: /_images/
-     :figclass: figure
-     :class: figure-img img-fluid
+`compas_framework` is a "meta package" that can be used to simplify the installation of the base framework of COMPAS.
 
 
 Table of Contents

docs/installation.rst

@@ -5,32 +5,34 @@ Installation
 Stable
 ======
 
-Stable releases are available on PyPI and can be installed with pip.
+For installation WITHOUT `compas_occ`
 
 .. code-block:: bash
 
     pip install compas_framework
 
+For installation WITH `compas_occ`
 
-Latest
-======
+.. code-block:: bash
 
-The latest version can be installed from local source.
+    conda create -n compas-dev -c conda-forge compas_occ
+    conda activate compas-dev
+    pip install compas_framework
+
+In both cases, for installation with support for Jupyter notebooks
 
 .. code-block:: bash
 
-    git clone https://github.com/compas-dev/compas_framework.git
-    cd compas_tna
-    pip install -e .
+    pip install "compas_framework[notebook]"
 
 
 Development
 ===========
 
-To install `compas_framework` for development, install from local source with the "dev" requirements.
+To install `compas_framework` for development, install from local source.
 
 .. code-block:: bash
 
     git clone https://github.com/compas-dev/compas_framework.git
-    cd compas_tna
-    pip install -e ".[dev]"
+    cd compas_framework
+    conda env create -f environment.yml

environment.yml

@@ -0,0 +1,11 @@
+name: compas-dev
+channels:
+  - conda-forge
+dependencies:
+  - python
+  - pip
+  - compas_occ >=1.3
+  - pip:
+      - .
+      - -r requirements-dev.txt
+      - -r requirements-notebook.txt