Metadata-Version: 2.1
Name: orbit-nrel
Version: 1.0.0
Summary: Offshore Renewables Balance of system and Installation Tool
Home-page: UNKNOWN
Author: Jake Nunemaker
License: UNKNOWN
Description: ORBIT
        =====
        
        Offshore Renewables Balance of system and Installation Tool
        
        
        :Version: 1.0.0
        :Authors: `Jake Nunemaker <https://www.linkedin.com/in/jake-nunemaker/>`_, `Matt Shields <https://www.linkedin.com/in/matt-shields-834a6b66/>`_, `Rob Hammond <https://www.linkedin.com/in/rob-hammond-33583756/>`_
        :Documentation: `ORBIT Docs <https://wisdem.github.io/ORBIT/>`_
        
        Installation
        ------------
        
        Environment Setup
        ~~~~~~~~~~~~~~~~~
        
        A couple of notes before you get started:
         - It is assumed that you will be using the terminal on MacOS/Linux or the
           Anaconda Prompt on Windows. The instructions refer to both as the
           "terminal", and unless otherwise noted the commands will be the same.
         - To verify git is installed, run ``git --version`` in the terminal. If an error
           occurs, install git using these `directions <https://git-scm.com/book/en/v2/Getting-Started-Installing-Git>`_.
         - The listed installation process is intended to be the easiest for any OS
           to get started. An alternative setup that doesn't rely on Anaconda for
           setting up an environment can be followed
           `here <https://realpython.com/python-virtual-environments-a-primer/#managing-virtual-environments-with-virtualenvwrapper>`_.
        
        
        Dependencies
        ~~~~~~~~~~~~
        
        - Python 3.7+
        - simpy-agents
        - marmot-agents
        - NumPy
        - SciPy
        - Matplotlib
        - OpenMDAO (>=3.2)
        
        Development
        ~~~~~~~~~~~
        
        - black
        - isort
        - pre-commit
        - pytest
        - pytest-xdist
        - pytest-cov
        - sphinx
        - sphinx-rtd-theme
        
        
        Recommended packages for easy iteration and running of code:
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        - jupyterlab
        - pandas
        
        
        Instructions
        ~~~~~~~~~~~~
        
        1. Download the latest version of `Miniconda <https://docs.conda.io/en/latest/miniconda.html>`_
           for the appropriate OS. Follow the remaining `steps <https://conda.io/projects/conda/en/latest/user-guide/install/index.html#regular-installation>`_
           for the appropriate OS version.
        2. From the terminal, install pip by running: ``conda install -c anaconda pip``
        3. Next, create a new environment for the project with the following.
        
            .. code-block:: console
        
                conda create -n <environment_name> python=3.7 --no-default-packages
        
           To activate/deactivate the environment, use the following commands.
        
            .. code-block:: console
        
                conda activate <environment_name>
                conda deactivate <environment_name>
        
        4. Clone the repository:
           ``git clone https://github.com/WISDEM/ORBIT.git``
        5. Navigate to the top level of the repository
           (``<path-to-ORBIT>/ORBIT/``) and install ORBIT as an editable package
           with following command.
        
            .. code-block:: console
        
               # Note the "." at the end
               pip install -e .
        
               # OR if you are you going to be contributing to the code or building documentation
               pip install -e '.[dev]'
        6. (Development only) Install the pre-commit hooks to autoformat code and
           check that tests pass.
        
            .. code-block:: console
        
                pre-commit install
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.7
Provides-Extra: dev
