Merge pull request #289 from cadCAD-org/pre_release

ver. 0.4.27

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog:
 
-### July 7, 2021
+### August 25, 2021
 #### New Features:
 * **ver. ≥ `0.4.27`:**
     * ##### [Experiments](documentation#experiments)
@@ -17,7 +17,8 @@
               * Users can no longer use the `config_list` method of `cadCAD.configuration.Experiment`
             * **Backwards Compatibility:** The `append_model` method of `cadCAD.configuration.Experiment` can also be used as 
               the `append_configs` method.
-    * ##### [Upgrade Guide:](documentation#cadCAD-v0.4.27-Model-Upgrade-Guide.md) specific to feature changes / additions
+    * Removed [Nix](https://nixos.org/)
+    * ##### [Upgrade Guide:](https://github.com/cadCAD-org/cadCAD/blob/master/documentation/cadCAD-v0.4.27-Model-Upgrade-Guide.md) specific to feature changes / additions
 * **Fixes:** 
     * [#248](https://github.com/cadCAD-org/cadCAD/issues/248)
         * The previous release was returning partial results. An A/B test for this has been included and will be for 

CONTRIBUTING.md

@@ -31,14 +31,14 @@ Contributing to an existing feature:
 7. PR is queued for review
 8. PR Reviewed (Update necessary if rejected)
 9. PR Approved (There may be circumstances delaying the merge.)
-10. Your contribution merged into next feature release on `org:master`
+10. Your contribution merged into next feature release on `org:main`
 
 ### Recommended Strategy: [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing)
 1. Add cadCAD-org/cadCAD as remote within you forked project locally.
-2. `git checkout remote/master`
-3. `git pull remote master`
+2. `git checkout remote/main`
+3. `git pull remote main`
 4. `git checkout your_branch`
-5. `git rebase master`
+5. `git rebase main`
 6. Resolve merge conflicts (while leveraging rebase commands)
 7. `git push fork your_branch`
 

README.md

@@ -25,7 +25,7 @@ through simulation, with support for Monte Carlo methods, A/B testing and parame
 [Previous Stable Release (No Longer Supported)](https://github.com/cadCAD-org/cadCAD/tree/b9cc6b2e4af15d6361d60d6ec059246ab8fbf6da)
 
 ## 0. Pre-installation Virtual Environments with [`venv`](https://docs.python.org/3/library/venv.html) (Optional):
-If you wish to create an easy to use virtual environment to install cadCAD inside of, please use the built in `venv` package.
+If you wish to create an easy to use virtual environment to install cadCAD within, please use python's the built in `venv` package.
 
 ***Create** a virtual environment:*
 ```bash
@@ -45,18 +45,18 @@ $
 ```
 
 ## 1. Installation: 
-Requires [>= Python 3.6](https://www.python.org/downloads/) 
+Requires [>= Python 3.6.13](https://www.python.org/downloads/) 
 
-**Option A: Install Using **[pip](https://test.pypi.org/project/cadCAD/0.4.27/)** 
+**Option A: Install Using **[pip](https://pypi.org/project/cadCAD/0.4.27/)** 
 ```bash
-$ pip3 install -i https://test.pypi.org/simple/ cadCAD==0.4.27
+pip3 install cadCAD
 ```
 
 **Option B:** Build From Source
 ```
-$ pip3 install -r requirements.txt
-$ python3 setup.py sdist bdist_wheel
-$ pip3 install dist/*.whl
+pip3 install -r requirements.txt
+python3 setup.py sdist bdist_wheel
+pip3 install dist/*.whl
 ```
 
 ## 2. Documentation:

documentation/cadCAD-v0.4.27-Model-Upgrade-Guide.md

@@ -6,7 +6,7 @@
         <th>
             ver. 0.4.27
         </th>
-      <th>
+        <th>
             ver. 0.4.23
         </th>
     </tr>

requirements.txt

@@ -1,22 +1,21 @@
 -i https://pypi.org/simple
 
-wheel>=0.35
-fn==0.4.3
-funcy==1.14
 matplotlib==3.3.2
 networkx==2.5
-numba==0.51.2
-numpy==1.19.2
-pandas==1.1.2
 parameterized==0.7.4
-pathos==0.2.6
 plotly==4.10.0
-pyarrow>=1.0.1
 pytest==6.0.2
 scikit-learn==0.23.2
 scipy>=1.5.2
 seaborn==0.11.0
 tabulate==0.8.7
 xarray==0.16.0
 wheel==0.36.2
-pytz==2019.3
+pandas==1.1.5
+fn==0.4.3
+funcy==1.16
+dill==0.3.4
+pathos==0.2.8
+numpy==1.19.5
+pytz==2021.1
+six>=1.11.0

setup.py

@@ -34,9 +34,13 @@
       packages=find_packages(),
       install_requires=[
             "pandas",
-            "pathos",
             "fn",
-            "funcy"
+            "funcy",
+            "dill",
+            "pathos",
+            "numpy",
+            "pytz",
+            "six"
       ],
       python_requires='>=3.6.13'
-)
+)