Merge pull request #234 from ModECI/test_outreachy_main

Readme updates

Author: pgleeson

.pre-commit-config.yaml

@@ -46,6 +46,6 @@ repos:
 #    files: src
 
 - repo: https://github.com/psf/black
-  rev: 20.8b1
+  rev: 22.3.0
   hooks:
   - id: black

CONTRIBUTING_GUIDELINE.md renamed to CONTRIBUTING.md

@@ -25,7 +25,7 @@ The implementation and dissemination of the MDF language and associated tools is
 
 <p align="center">
   <a href="examples/README.md">
-    <img alt="mdf interacts" width="400" src="examples/ModECI_MDF.png"/>
+    <img alt="mdf interactions" width="400" src="https://github.com/ModECI/MDF/raw/main/examples/ModECI_MDF.png"/>
   </a>
 <br/><sup><i><b>Fig 1:</b> Some of the current and planned formats which MDF will interact with. Click on the image for more information.</i></sup></p>
 
@@ -54,8 +54,41 @@ Successful interfacing of MDF to existing disciplinary standards (such as [ONNX]
 
 <p align="center"><img src="docs/images/MDFgraph2.png" width="700px"><br/><sup><i><b>Fig 3:</b> This graph illustrates the ability to specify behavior that extends beyond the directed flow through the graph. Here, Node 1 generates a random number and transmits that number to Node 2. Node 2 will only run if the number it receives from Node 1 is greater than 10.</i></sup></p>
 
+## Installation
+
+### Requirements
+Requires Python >= 3.7
+
+### Installation steps
+To install the MDF package and run it locally:
+
+1. Clone this repository
+```
+git clone https://github.com/ModECI/MDF.git
+```
+2. Change to the directory
+```
+cd MDF
+```
+3. Create a virtual environment (e.g. called `mdf-env`)
+```
+pip install virtualenv
+virtualenv mdf-env
+```
+4. Activate the virtual environment
+```
+source MDF-env/bin/activate
+```
+5. Install the package
+```
+pip install .
+```
+
 ## Examples
 
+To get started, follow the simple example in a Jupyter notebook [here](https://github.com/ModECI/MDF/blob/main/examples/SimpleExample.ipynb)
+
+
 Multiple examples of serialized MDF files, the Python scripts used to generate them, as well as mappings to target environments can be found [here](https://github.com/ModECI/MDF/blob/main/examples/README.md).
 
 [actions-badge]:            https://github.com/ModECI/MDF/actions/workflows/ci.yml/badge.svg

README.md

@@ -135,7 +135,7 @@ def color_rgb_to_hex(rgb):
 
 
 def is_number(s):
-    """Return :code:`True` if cast to :code:`float` does not throw ValueError, :code:`False` otherwise. """
+    """Return :code:`True` if cast to :code:`float` does not throw ValueError, :code:`False` otherwise."""
     try:
         float(s)
         return True

src/modeci_mdf/utils.py

@@ -94,7 +94,7 @@ def test_ConditionSet_init_kwargs():
 
 
 def test_Condition_init_kwargs():
-    """ Check the working of Condition"""
+    """Check the working of Condition"""
     C = Condition(type="test_type", n="test_n", dependency="test_dependency")
     assert C.type == "test_type"
     assert C.args == {"n": "test_n", "dependency": "test_dependency"}