To install the PARETO framework on Windows operating systems, follow the set of instructions below that are appropriate for your needs. If you need assistance please contact start a new discussion on our GitHub Discussion form or send an email to firstname.lastname@example.org.
The installation instructions vary slightly depending on the role you will have with Project Pareto. Below are the roles we’ve identified:
Users: Use the PARETO platform to develop models, but never contribute to development of the framework (i.e. never commit changes to the project-pareto repo). This includes people who only work with protected data.
Core-dev: Work primarily on PARETO platform development and never handle protected data.
Hybrid: Handle protected data, but also commit changes to the project-pareto repo (even occasionally) - needs approval from PhD. Markus Drouven
Install Miniconda (optional)
Install anaconda from the downloaded file in (1).
Open the Anaconda Prompt (Start -> “Anaconda Prompt”).
If you are using Python for other complex projects, you may want to consider using environments of some sort to avoid conflicting dependencies. There are several good options including conda environments if you use Anaconda.
Non-git tracked option
Install PARETO with pip by one of the following methods
To get the latest release:pip install project-pareto
To get a specific release, for example 1.6.3:pip install project-pareto==1.6.3
If you need unreleased cutting-edge development versions of PARETO, you can install PARETO directly from the GitHub repo either from the main PARETO repo or a developer’s fork and branch (this installs from GitHub but does not create a local git clone/workspace):pip install git+https://github.com/project-pareto/project-pareto.git pip install git+https://github.com/ksbeattie/project-pareto@feature_1
Fork the repo on GitHub (your copy of the main repo)
Clone your fork locally, creating a workspace (github id is “myusername,”):
git clone https://github.com/myusername/project-pareto git clone email@example.com:myusername/project-pareto.
In this new project-pareto directory, run the following command which installs PARETO in editable mode so that developers can make changes and push to their fork/branch:
pip install -e
User that can edit the base code
conda create -n pareto-env python=3.8pip --yes conda activate pareto-env
Download zip files (project-pareto-main)
Unpack zip files (select directory)
Install pareto-project (non-git tracked repo):
pip install -r requirements-dev.txt
We use Sphinx for writing and building our on-line documentation. This is a tool that translates a set of plain text .rst (reStructuredText) files into various output formats, such as HTML or PDF (via Latex).
After installing as a Core-dev or Users (as described above) you can build the documentation locally on your system by running the make command in the docs folder, as follows:
$ cd project-pareto/docs/ $ make html
Visit the Sphinx Style Guide for information on syntax rules, tips, and FAQ.