astk

Toolkit package for alinea

https://github.com/openalea/astk

Science Score: 44.0%

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

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (15.4%) to scientific vocabulary

Keywords

fspm lightning openalea pvlib sky
Last synced: 6 months ago · JSON representation ·

Repository

Toolkit package for alinea

Basic Info
Statistics
  • Stars: 3
  • Watchers: 4
  • Forks: 5
  • Open Issues: 4
  • Releases: 8
Topics
fspm lightning openalea pvlib sky
Created over 9 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing License Citation

README.md

Docs Build Status Python Version License Anaconda-Server Badge

Astk

Astk allows to calculate sky luminance and sky sources to be used with FSPM light models from weather data.

Contents

  • sky_irradiance: Equation for determining global horizontal irradiance (GHI), direct normal irradiance (DNI) and diffuse horizontal irradiance under clearsky condition or estimate them from meteorological data using pvlib library.
  • sun_position: Sun position using pvlib library.
  • sunpositionastk : Astronomical equation for determining sun position.
  • TimeControl: Provides utilities for scheduling models in simulation.
  • Weather: Provides utilities for weather protocol and conversion of some weather variable.
  • data_access: Set of function to work with resources that are located inside this package data.
  • icosphere : Generation of regular spherical polyhedrons: icospheres and their hexagonal/pentagonal duals.
  • plantgl_utils: A generic module to get plant variable from scene.
  • sky_sources: A collection of equation for modelling sun position, sun irradiance and sky irradiance.

Installation

Users

bash mamba create -n astk -c openalea3 -c conda-forge openalea.astk openalea.plantgl matplotlib

Developers

```bash git clone 'https://github.com/openalea-incubator/astk.git' cd astk

this will create a fresh astk_dev env for you

mamba env create -f ./conda/environment.yml

As an alternative, if you want to work in an existing environment:

mamba install --only-deps -c openalea3 -c conda-forge openalea.astk pip install -e .[doc,test,plot] ```

Quick start

```python from openalea.astk.skyirradiance import skyirradiance from openalea.astk.skysources import skysources

irradiance = skyirradiance() sources = skysources('all-weather', irradiance) ```

See other example in the documentation

Credits

The package was mainly developed by Christian Fournier @christian34, researcher at INRAE.

All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome.

A detailed overview on how to contribute can be found in the contributing guide

Contributors

Thanks to all that ontribute making this package what it is !

Owner

  • Name: OpenAlea
  • Login: openalea
  • Kind: organization

OpenAlea is an open source project aimed at the plant research community. It includes modules to analyse and model growth and functioning of plant architectures

Citation (CITATION.cff)

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: astk
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Christian
    family-names: Fournier
    email: christian.fournier@inrae.fr
    affiliation: INRAE
    orcid: 'https://orcid.org/0000-0001-7098-8278'
repository-code: 'https://github.com/openalea-incubator/astk'
license: CECILL-C

GitHub Events

Total
  • Issues event: 1
  • Delete event: 1
  • Push event: 8
  • Pull request event: 3
  • Create event: 4
Last Year
  • Issues event: 1
  • Delete event: 1
  • Push event: 8
  • Pull request event: 3
  • Create event: 4

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • pradal (1)
Pull Request Authors
  • christian34 (3)
Top Labels
Issue Labels
Pull Request Labels

Dependencies

dvlpt_requirements.txt pypi
  • coverage *
  • mock *
  • nose *
  • sphinx *
.github/workflows/conda-package-build.yml actions
requirements.txt pypi
setup.py pypi