Data

Tools

Indexes

Applications

Experiments

Open Source Science

pvpumpingsystem

pvpumpingsystem: A Python package for modeling and sizing photovoltaic water pumping systems - Published in JOSS (2020)

https://github.com/tylunel/pvpumpingsystem

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    1 of 2 committers (50.0%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software
Last synced: 6 months ago · JSON representation

Repository

Provides tools for modeling photovoltaic water pumping system

Basic Info
  • Host: GitHub
  • Owner: tylunel
  • License: gpl-3.0
  • Language: Python
  • Default Branch: master
  • Size: 23.5 MB
Statistics
  • Stars: 7
  • Watchers: 3
  • Forks: 4
  • Open Issues: 0
  • Releases: 3
Created over 6 years ago · Last pushed over 2 years ago
Metadata Files
Readme License

README.md

CI general checks Coverage Documentation Status Binder DOI

Logo

pvpumpingsystem

pvpumpingsystem is a package providing tools for modeling and sizing photovoltaic water pumping systems.

Schema of a PV pumping system

It can model the whole functioning of such pumping system on an hourly basis and eventually provide key financial and technical findings on a year. Conversely it can help choose some elements of the pumping station depending on output values wanted (like daily water consumption and acceptable risk of water shortage). Further details are provided on the scope page of the documentation.

Documentation

The full package documentation is available on readthedocs:

pvpumpingsystem docs

Installation

pvpumpingsystem works with Python 3.5 and superior only.

With pip

For a rapid installation with pip, type in a command line interface: python -m pip install pvpumpingsystem

Consult the docs for more information on installation: https://pvpumpingsystem.readthedocs.io/en/latest/installation.html

Hands-on start

Three examples of how the software can be used are in the folder 'docs/examples'.

For a given system, the first two show how to obtain the outflows, probability of water shortage, life cycle cost and many other results:

Basic usage example

More advanced usage example

The third shows how to optimize the selection of one or more component on the pumping station based on user requirements:

Sizing example

Contributions

All kind of contributions (documentation, testing, bug reports, new features, suggestions...) are highly appreciated. They can be reported as issues, pull requests, or simple message via Github (prefered) or via mail of the maintainer.

JOSS Publication

pvpumpingsystem: A Python package for modeling and sizing photovoltaic water pumping systems
Published
October 27, 2020
DOI
Volume 5, Issue 54, Page 2637
Authors
Tanguy R. Lunel ORCID
Industrial Research Group In Technologies of Energy and Energy Efficiency (T3E), Department of Mechanical Sciences, Ecole de Technologie Supérieure Montreal, Department of Material Science and Engineering, Institut National des Sciences Appliquées Rennes
Daniel R. Rousse ORCID
Industrial Research Group In Technologies of Energy and Energy Efficiency (T3E), Department of Mechanical Sciences, Ecole de Technologie Supérieure Montreal
Editor
Katy Barnhart ORCID
Tags
sizing modeling water pumping photovoltaics solar energy
View PDF Review Thread Software Archive

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 421
  • Total Committers: 2
  • Avg Commits per committer: 210.5
  • Development Distribution Score (DDS): 0.005
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Lunel t****1@e****a 419
Barnhart, Katherine (Katy) Ruth k****t@u****v 2
Committer Domains (Top 20 + Academic)
usgs.gov: 1 ens.etsmtl.ca: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: about 9 hours
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • kbarnhart (1)
  • stephansmit (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 12 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 1
  • Total maintainers: 1
pypi.org: pvpumpingsystem

Module for simulating off-grid photovoltaic powered pumping station

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 12 Last month
Rankings
Dependent packages count: 10.1%
Forks count: 15.3%
Stargazers count: 19.3%
Dependent repos count: 21.6%
Average: 29.7%
Downloads: 82.2%
Maintainers (1)
tylunel
Last synced: 6 months ago

Dependencies

setup.py pypi
  • fluids *
  • matplotlib *
  • numpy-financial *
  • pvlib *
  • pytest *
  • sklearn *
  • tqdm *
.github/workflows/pythonapp.yml actions
  • actions/checkout v1 composite
  • actions/setup-python v1 composite
.github/workflows/pythonpackage.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v1 composite
docs/source/environment.yml pypi