What is pvcaptest?
pvcaptest is an open source python package created to facilitate capacity testing following the ASTM E2848 standard. The captest module contains a single class, CapData, which provides methods for loading, visualizing, filtering, and regressing capacity testing data. The module also includes functions that take CapData objects as arguments and provide summary data and capacity test results.
Documentation and examples are available on readthedocs including full examples in jupyter notebooks that can be run in the browser without installing anything.
These instructions assume that you are new to using conda and python, if that is not the case skip to the last section for users familiar with conda and pip.
The recommended method to install pvcaptest is to create a conda environment for pvcaptest. Installing Anaconda or miniconda will install both python and conda. There is no need to install python separately.
- Download and install the anaconda distribution. Follow the default installation settings.
- On Windows go to the start menu and open the Anaconda prompt under the newly installed Anaconda program. On OSX or Linux open a terminal window.
- Install pvcaptest by typing the command
conda install -c conda-forge pvcaptestand pressing enter. The
-c conda-forgeoption tells conda to install pvcaptest from the conda forge channel.
This will install the pvcaptest package in the base environment created when Anaconda is installed. This should work and provide you with jupyter notebook and jupyer lab to run pvcaptest in. If you think you will use your Anaconda installation to create and maintain additional environments, the following process for creating a stand alone option is likely a better option.
Better long term option:
- If you do not already have it installed, download and install the anaconda distribution or miniconda.
- Go to the project github page and download the project source to obtain a copy of the
environment.ymlfile. Click the green code button and click 'Download ZIP'.
- On Windows go to the start menu and open the Anaconda prompt under the newly installed Anaconda program. On OSX or Linux open a terminal window. Note the path in the prompt for the next step. On Windows this should be something like
- Unzip and move the
environment.ymlfile to the folder identified by the path from the previous step.
- In your Anaconda prompt or terminal type
conda env create -f environment.yml
and hit enter. Wait for a few seconds while conda works to solve the environment. It should ask you if you want to proceed to install new packages including pvcaptest. Type
yenter to proceed and wait for conda to finish installing pvcaptest and the other packages.
- Once the installation is complete conda will print out a command for activating the new environment. Run that command, which should be like
conda activate captest_env.
The environment created will include jupyter lab and notebook for you to use pvcaptest in. You can start these using the commands
jupyter lab or
See the conda documentation for more details on using conda to create and manage environments.
Install for users familiar with conda and pip:
Conda install into an existing environment:
conda install -c conda-forge pvcaptest
If you prefer, you can pip install pvcaptest, but the recommended approach is to use the conda package.
Note: The conda package is named pvcaptest and the pip package is named captest. The project is moving to consistent use of the pvcaptest name, but the package name on pypi will remain as captest.