Installation instructions#
Ard is currently in pre-release. It can be installed from PyPI or as a source-code installation.
1. Clone Ard source repository#
If installing from PyPI, skip to step 2.. If installing from source, the source can be cloned from github using the following command in your preferred location:
git clone git@github.com:WISDEM/Ard.git
Once downloaded, you can enter the Ard root directory using
cd Ard
2. Set up environment#
At this point, although not strictly required, we recommend creating a dedicated conda environment with pip, python=3.12, and mamba in it (except on apple silicon):
On Apple silicon#
For Apple silicon, we recommend installing Ard natively.
conda CONDA_SUBDIR=osx-arm64 conda create -n ard-env
conda activate ard-env
conda env config vars set CONDA_SUBDIR=osx-arm64 # this command makes the environment permanently native
conda install python=3.12
Or, on Intel#
create --name ard-env
conda activate ard-env
conda install python=3.12 pip mamba -y
3. Install Ard#
From here, installation can be handled by pip.
To install from PyPI#
pip install ard-nrel
For a basic and static installation from source, run:#
pip install .
For development (and really for everyone during pre-release), we recommend a full development installation from source:#
pip install -e .[dev,docs]
which will install in "editable mode" (-e), such that changes made to the source will not require re-installation, and with additional optional packages for development and documentation ([dev,docs]).
If you have problems with WISDEM not installing correctly#
There can be some hardware-software mis-specification issues with WISDEM installation from pip for MacOS 12 and 13 on machines with Apple Silicon.
In the event of issues, WISDEM can be installed manually or using conda without issues, then pip installation can proceed.
mamba install wisdem -y
pip install -e .[dev,docs]