Skip to main content

Framework and methods to facilitate photovoltaic facility capacity testing following ASTM E2848.

Project description

pvcaptest

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.

Installation

With Conda

These instructions assume that you are new to python and managing virtual environments to isolate pvcaptest and its dependencies from the rest of your operating system. If you are not sure what that means, these instructions (using miniforge) are for you!

Install Miniforge

The first step to using pvcaptest is to install pvcaptest and Jupyter into an isolated python environment. These directions guide you through the steps to use conda to do that.

Miniforge will install conda, but with the default source for packages set to conda-forge.

  1. Go to the Miniforge github page to download miniforge. Pick the correct installation option for your operating system and follow the directions.

Windows:

  • Use the default options and the .exe installer.

OSX / Linux:

  • Open a command line (Type command + space to open Spotlight and type terminal and open your default terminal app) and copy and paste the commands and hit enter.

Installing pvcaptest

Open a command line, which we will use to run the conda commands required to install pvcaptest.

  • Windows: Type miniforge into your search bar and select the Miniforge Prompt app, which should be the first option.

  • OSX: Type command + space to open Spotlight and type terminal and open your default terminal app.

Now we can use conda to create a new conda environment and install pvcaptest, its dependencies, and Jupyter. Copy and paste the following command into the command line and hit enter:

conda create --name pvcaptest python=3.12 pvcaptest notebook

See the conda documentation for managing environments for more information on what that command is doing.

Once the installation finishes, you should see a message similar to the one below. The installation process should run for 5-10 minutes, but it will depend on your computer specs and internet speed.

```Preparing transaction: done Verifying transaction: done Executing transaction: done # # To activate this environment, use # # $ conda activate pvcaptest # # To deactivate an active environment, use # # $ conda deactivate

Retrieving notices: …working… done ```

Activate the environment using the command provded.

Try running this command in your terminal as a quick check that pvcaptest did install correctly:

python -c 'import captest; print(captest.__version__)

You may see some warning messages, but at the bottom you should see a version number.You should have the latest version installed; 0.13.3 or later. You can check what the most recent release is on pypi.

Congratulations! You now have pvcaptest installed in an isolated conda environment.

Run jupyter lab which will open jupyter lab in your default browser. You can now use pvcaptest in jupyter lab.

You may want to either navigate to the folder containing your project files in the terminal before running jupyter lab or store your project files in a location you can easily navigate to in jupyter lab’s file browser.

With uv - Contributors

Using uv is the preferred method for contributors setting up a development installation as of v0.13.3. See MAINTAINER.md for additional details, specifically the section on just.

Install uv and clone your fork of the repository.

The just recipes (commands) use uv run ... to run development workflow commands (e.g., uv run --python 3.12 pytest tests/) and uv run will ensure a venv with the necessary dependencies is used.

With pip

pip install captest

or with optional dependencies:

pip install captest[optional]

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

captest-0.13.3.tar.gz (3.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

captest-0.13.3-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file captest-0.13.3.tar.gz.

File metadata

  • Download URL: captest-0.13.3.tar.gz
  • Upload date:
  • Size: 3.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for captest-0.13.3.tar.gz
Algorithm Hash digest
SHA256 9c47cf64d33a59dab2b57529d8ce85dae048351f9e422d51609025b525f08590
MD5 b5a759a35dbb92c24851e696a52831e9
BLAKE2b-256 859973fc409fb6026c6ce2edd17e872e1bc3a31fe106bed8c0653ac18f4f4eb6

See more details on using hashes here.

File details

Details for the file captest-0.13.3-py3-none-any.whl.

File metadata

  • Download URL: captest-0.13.3-py3-none-any.whl
  • Upload date:
  • Size: 52.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.0 {"installer":{"name":"uv","version":"0.10.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for captest-0.13.3-py3-none-any.whl
Algorithm Hash digest
SHA256 86a8072c2888efe1fa0719b7a5349ddc20223adf19d2d44d1fb2f2c715ae59a4
MD5 fe87bc66faa29426b57887f2d2b4245e
BLAKE2b-256 2b4ea0ea1a353c16c59a9790303d33f385a4951fb9e4ce2954e2d09a45c4344f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page