diff --git a/.github/workflows/fair-software.yml b/.github/workflows/fair-software.yml new file mode 100644 index 00000000..dbeab053 --- /dev/null +++ b/.github/workflows/fair-software.yml @@ -0,0 +1,17 @@ +name: fair-software + +on: + push: + branches: [main] + +jobs: + verify: + name: "fair-software" + runs-on: ubuntu-latest + steps: + - uses: fair-software/howfairis-github-action@0.2.1 + name: Measure compliance with fair-software.eu recommendations + env: + PYCHARM_HOSTED: "Trick colorama into displaying colored output" + with: + MY_REPO_URL: "https://github.com/${{ github.repository }}" diff --git a/CITATION.cff b/CITATION.cff new file mode 100644 index 00000000..1f290b40 --- /dev/null +++ b/CITATION.cff @@ -0,0 +1,78 @@ +# This CITATION.cff file was generated with cffinit. +# Visit https://bit.ly/cffinit to generate yours today! + +cff-version: 1.2.0 +title: >- + ARTIST - AI-enhanced differentiable Ray Tracer for + Irradiation Prediction in Solar Tower Digital Twins +message: >- + If you use this software, please cite it using the + metadata from this file. +type: software +authors: + - given-names: Max + family-names: Pargmann + email: max.pargmann@dlr.de + affiliation: German Aerospace Center (DLR) + orcid: 'https://orcid.org/0000-0002-4705-6285' + - given-names: Kaleb + family-names: Phipps + email: kaleb.phipps@kit.edu + affiliation: Karlsruhe Institute of Technology (KIT) + orcid: 'https://orcid.org/0000-0002-9197-1739' + - given-names: Marie + family-names: Weiel + email: marie.weiel@kit.edu + affiliation: Karlsruhe Institute of Technology (KIT) + orcid: 'https://orcid.org/0000-0001-9648-4385' + - given-names: Marlene + family-names: Busch + email: marlene.busch@dlr.de + affiliation: German Aerospace Center (DLR) + - given-names: Mathias + family-names: Kuhl + email: mathias.kuhl@dlr.de + affiliation: German Aerospace Center (DLR) + orcid: 'https://orcid.org/0000-0003-0097-7260' + - given-names: Felix + family-names: Göhring + email: felix.goehring@dlr.de + affiliation: German Aerospace Center (DLR) + - given-names: Daniel + family-names: Maldonado Quinto + email: daniel.maldonadoquinto@dlr.de + affiliation: German Aerospace Center (DLR) + - given-names: Robert + family-names: Pitz-Paal + orcid: 'https://orcid.org/0000-0002-3542-3391' + email: robert.pitz-paal@dlr.de + affiliation: German Aerospace Center (DLR) + - given-names: Moritz + family-names: Leibauer + email: moritz.leibauer@synhelion.com + affiliation: Synhelion Germany + - given-names: Markus + family-names: Götz + email: markus.goetz@kit.edu + affiliation: Karlsruhe Institute of Technology (KIT) + orcid: 'https://orcid.org/0000-0002-2233-1041' +repository-code: 'https://github.com/ARTIST-Association/ARTIST' +url: 'https://artist.readthedocs.io/en/latest/?badge=latest' +abstract: >- + The ARTIST package provides an implementation of a + differentiable ray tracer using the PyTorch + machine-learning framework in Python. Leveraging automatic + differentiation and GPU computation, it facilitates the + optimization of heliostats, solar towers, and camera parameters + within a solar field by combining gradient-based + optimization methods with smooth parametric descriptions + of heliostats. +keywords: + - Solar Tower Power Plant + - Concentrated Solar Energy + - Differentiable Ray Tracing + - Digital Twin + - Heliostat Calibration + - Surface Reconstruction + - Python +license: MIT diff --git a/README.md b/README.md index ccbf6b79..c2338a95 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,12 @@ # AI-enhanced differentiable Ray Tracer for Irradiation Prediction in Solar Tower Digital Twins [![](https://img.shields.io/badge/Python-3.9+-blue.svg)](https://www.python.org/downloads/) -[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)[![codecov](https://codecov.io/gh/ARTIST-Association/ARTIST/graph/badge.svg?token=AEUYvTNXz1)](https://codecov.io/gh/ARTIST-Association/ARTIST) +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +[![codecov](https://codecov.io/gh/ARTIST-Association/ARTIST/graph/badge.svg?token=AEUYvTNXz1)](https://codecov.io/gh/ARTIST-Association/ARTIST) [![](https://img.shields.io/badge/Contact-artist%40lists.kit.edu-orange?label=Contact)](artist@lists.kit.edu) [![Documentation Status](https://readthedocs.org/projects/artist/badge/?version=latest)](https://artist.readthedocs.io/en/latest/?badge=latest) +[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B%20%20%E2%97%8B%20%20%E2%97%8B-orange)](https://fair-software.eu) ## What ``ARTIST`` can do for you