Skip to content

Commit

Permalink
update reuse license and docs (#400)
Browse files Browse the repository at this point in the history
* update reuse

* fix bsd-2

* rename: Atlite -> atlite

* resolve review comments
  • Loading branch information
lkstrp authored Nov 11, 2024
1 parent 77177bf commit 8bdae17
Show file tree
Hide file tree
Showing 112 changed files with 215 additions and 220 deletions.
2 changes: 1 addition & 1 deletion .coveragerc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
2 changes: 1 addition & 1 deletion .git-blame-ignore-revs
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0
name: Bug Report
Expand All @@ -20,10 +20,10 @@ body:
options:
- label: >
I have confirmed this bug exists on the lastest
[release](https://github.com/pypsa/atlite/releases) of Atlite.
[release](https://github.com/pypsa/atlite/releases) of atlite.
- label: >
I have confirmed this bug exists on the current
[`master`](https://github.com/pypsa/atlite/tree/master) branch of Atlite.
[`master`](https://github.com/pypsa/atlite/tree/master) branch of atlite.
- type: textarea
id: problem
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0
blank_issues_enabled: false
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ assignees: ''

---
<!---
SPDX-FileCopyrightText: 2021 The Atlite Authors
SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
SPDX-License-Identifier: CC0-1.0
--->
Expand Down
2 changes: 1 addition & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
2 changes: 1 addition & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--
SPDX-FileCopyrightText: 2021 The Atlite Authors
SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
SPDX-License-Identifier: CC0-1.0
-->
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
name: Tests
Expand Down
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2021 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0
ci:
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-

# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT

Expand Down
8 changes: 4 additions & 4 deletions .reuse/dep5
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: Atlite
Upstream-Name: atlite
Upstream-Contact: Jonas Hörsch <[email protected]>
Source: https://github.com/PyPSA/atlite

Files: doc/img/*
Copyright: 2019 - 2023 The Atlite Authors
Copyright: Contributors to atlite <https://github.com/pypsa/atlite>
License: CC-BY-4.0

Files: doc/workflow*
Copyright: 2021 The Atlite Authors
Copyright: Contributors to atlite <https://github.com/pypsa/atlite>
License: CC-BY-4.0

Files: doc/examples/*.nblink
Copyright: 2020 - 2023 The Atlite Authors
Copyright: Contributors to atlite <https://github.com/pypsa/atlite>
License: CC-BY-4.0
2 changes: 1 addition & 1 deletion AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
..
SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
SPDX-License-Identifier: CC-BY-4.0

Expand Down
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: : 2022 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: CC0-1.0

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!---
SPDX-FileCopyrightText: 2021 The Atlite Authors
SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
SPDX-License-Identifier: CC0-1.0
--->

Atlite's contributor guidelines can be found in the official [documentation](https://atlite.readthedocs.io/en/master/contributing.html).
atlite's contributor guidelines can be found in the official [documentation](https://atlite.readthedocs.io/en/master/contributing.html).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2016 - 2024 The Atlite Authors
Copyright (c) Contributors to atlite

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
2 changes: 1 addition & 1 deletion LICENSES/BSD-2-Clause.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (c) <year> <owner>. All rights reserved.
Copyright (c) Contributors to atlite. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
Expand Down
20 changes: 16 additions & 4 deletions LICENSES/MIT.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,21 @@
MIT License

Copyright (c) 2017 - 2023 The Atlite Authors
Copyright (c) Contributors to atlite

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
18 changes: 9 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
.. SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
.. SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
.. SPDX-License-Identifier: CC-BY-4.0
======
Atlite
atlite
======

|PyPI version| |Conda version| |Documentation Status| |ci| |codecov| |standard-readme compliant| |MIT-image| |reuse| |black| |pre-commit.ci| |joss| |discord| |stackoverflow|

Atlite is a `free software`_, `xarray`_-based Python library for
atlite is a `free software`_, `xarray`_-based Python library for
converting weather data (like wind speeds, solar influx) into energy systems data.
It is designed to be lightweight, keeping computing resource requirements (CPU, RAM) usage low.
It is therefore well suited to be used with big weather datasets.

.. Atlite is designed to be modular, so that it can work with any weather
.. atlite is designed to be modular, so that it can work with any weather
.. datasets. It currently has modules for the following datasets:
.. * `NCEP Climate Forecast System <http://rda.ucar.edu/datasets/ds094.1/>`_ hourly
Expand All @@ -31,7 +31,7 @@ It is therefore well suited to be used with big weather datasets.
.. combined with ERA5 temperature).
Atlite can process the following weather data fields and can convert them into following power-system relevant time series for any subsets of a full weather database.
atlite can process the following weather data fields and can convert them into following power-system relevant time series for any subsets of a full weather database.

.. image:: doc/workflow_chart.png

Expand All @@ -53,7 +53,7 @@ Atlite can process the following weather data fields and can convert them into f
.. * Heating demand (based on the degree-day approximation)
Atlite was initially developed by the `Renewable Energy Group
atlite was initially developed by the `Renewable Energy Group
<https://fias.uni-frankfurt.de/physics/schramm/renewable-energy-system-and-network-analysis/>`_
at `FIAS <https://fias.uni-frankfurt.de/>`_ to carry out simulations
for the `CoNDyNet project <http://condynet.de/>`_, financed by the
Expand Down Expand Up @@ -120,7 +120,7 @@ Support & Contributing
Authors and Copyright
---------------------

Copyright (C) 2016 - 2023 The Atlite Authors.
Copyright (C) Contributors to atlite <https://github.com/pypsa/atlite>

See the `AUTHORS`_ for details.

Expand Down Expand Up @@ -166,8 +166,8 @@ See the individual files for license details.
:target: LICENSES/MIT.txt
.. |codecov| image:: https://codecov.io/gh/PyPSA/atlite/branch/master/graph/badge.svg?token=TEJ16CMIHJ
:target: https://codecov.io/gh/PyPSA/atlite
.. |ci| image:: https://github.com/PyPSA/atlite/actions/workflows/CI.yaml/badge.svg
:target: https://github.com/PyPSA/atlite/actions/workflows/CI.yaml
.. |ci| image:: https://github.com/PyPSA/atlite/actions/workflows/test.yaml/badge.svg
:target: https://github.com/PyPSA/atlite/actions/workflows/test.yaml
.. |reuse| image:: https://api.reuse.software/badge/github.com/pypsa/atlite
:target: https://api.reuse.software/info/github.com/pypsa/atlite
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
Expand Down
16 changes: 8 additions & 8 deletions RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
..
SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
SPDX-License-Identifier: CC-BY-4.0

Expand Down Expand Up @@ -126,7 +126,7 @@ Version 0.2.8
* Bugfix: When only adding geometries to an `atlite.ExclusionContainer` the geometries were previously
not opened and an error was thrown. The error did not occur if one or more shapes were included.
Error is corrected and geometry-only exclusions can now be calculated. (GH Issue #225)
* Atlite now includes the reference turbines from the NREL turbine archive (see: https://nrel.github.io/turbine-models/). Available turbines can be consulted using `atlite.windturbines` and can be passed as string argument, e.g. `coutout.wind(turbine)`.
* atlite now includes the reference turbines from the NREL turbine archive (see: https://nrel.github.io/turbine-models/). Available turbines can be consulted using `atlite.windturbines` and can be passed as string argument, e.g. `coutout.wind(turbine)`.
* Bugfix: Downsampling the availability matrix (high resolution to low resolution) failed. Only rasters with 0 or 1
were produced. Expected are also floats between 0 and 1 (GH Issue #238). Changing the rasterio version solved this.
See solution (https://github.com/PyPSA/atlite/pull/240).
Expand All @@ -143,16 +143,16 @@ Version 0.2.7
Version 0.2.6
==============

* Atlite now supports calculating dynamic line ratings based on the IEEE-738 standard (https://github.com/PyPSA/atlite/pull/189).
* atlite now supports calculating dynamic line ratings based on the IEEE-738 standard (https://github.com/PyPSA/atlite/pull/189).
* The wind feature provided by ERA5 now also calculates the wind angle `wnd_azimuth` in range [0 - 2π) spanning the cirlce from north in clock-wise direction (0 is north, π/2 is east, -π is south, 3π/2 is west).
* A new intersection matrix function was added, which works similarly to incidence matrix but has boolean values.
* Atlite now supports two CSP (concentrated solar power) technologies, solar tower and parabolic trough. See (https://atlite.readthedocs.io/en/latest/examples/working-with-csp.html) for details.
* atlite now supports two CSP (concentrated solar power) technologies, solar tower and parabolic trough. See (https://atlite.readthedocs.io/en/latest/examples/working-with-csp.html) for details.
* The solar position (azimuth and altitude) are now part of the cutout feature `influx`. Cutouts created with earlier versions will become incompatible with the next major.
* Automated upload of code coverage reports via Codecov.
* DataArrays returned by `.pv(...)` and `.wind(...)` now have a clearer name and 'units' attribute.
* If the `matrix` argument in conversion functions (`.pv(...)`, `.wind(...)` etc.) is a `DataArray`, the alignment of the coordinate axis with the cutout grid is double-checked.
* Due to ambiguity, conversion functions (`.pv(...)`, `.wind(...)` etc.) now raise an `ValueError` if shapes and matrix are given.
* Atlite now supports calculating of heat pump coefficients of performance (https://github.com/PyPSA/atlite/pull/145).
* atlite now supports calculating of heat pump coefficients of performance (https://github.com/PyPSA/atlite/pull/145).
* Enabled the GitHub feature "Cite this repository" to generate a BibTeX file (Added a `CITATION.cff` file to the repository).

**Bug fixes**
Expand Down Expand Up @@ -214,8 +214,8 @@ Version 0.2
**Major changes**


* Atlite now **requires Python 3.6 or higher**.
* We changed the Atlite backend for storing cutout data.
* atlite now **requires Python 3.6 or higher**.
* We changed the atlite backend for storing cutout data.
Existing cutouts either need to be migrated with the
appropriate functions or (what we recommended) recreated.
* The backend change also includes some changes to the API.
Expand All @@ -242,7 +242,7 @@ Version 0.2
`Open Energy Database <https://openenergy-platform.org/dataedit/view/supply/turbine_library>`_
using the string prefix `"oedb:"` when specifying a turbine,
e.g. `"oedb:Enercon_E-141/4200"`.
* Atlite now has and uses a new configuration system.
* atlite now has and uses a new configuration system.
See the new section on `configuration <https://atlite.readthedocs.io/en/latest/configuration.html>`_
for details.
* It is possible to merge two cutouts together, using `Cutout.merge`
Expand Down
10 changes: 5 additions & 5 deletions atlite/__init__.py
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Atlite helps you to convert weather data into energy systems model data.
atlite helps you to convert weather data into energy systems model data.
Atlite is a free software, xarray-based Python library for converting
atlite is a free software, xarray-based Python library for converting
weather data (like wind speeds) into energy systems data. It is designed
to by lightweight and work with big weather datasets while keeping the
resource requirements especially on CPU and RAM resources low.
"""

__author__ = (
"The Atlite Authors: Gorm Andresen (Aarhus University), "
"Gorm Andresen, "
"Jonas Hoersch (FIAS/KIT/RLI), "
"Johannes Hampp (JLUG),"
"Fabian Hofmann (FIAS)"
Expand All @@ -20,7 +20,7 @@
"David Schlachtberger (FIAS), "
)

__copyright__ = "Copyright 2016 - 2021 The Atlite Authors"
__copyright__ = "Copyright Contributors to atlite"

import re
from importlib.metadata import version
Expand Down
2 changes: 1 addition & 1 deletion atlite/aggregate.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Expand Down
2 changes: 1 addition & 1 deletion atlite/convert.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Expand Down
2 changes: 1 addition & 1 deletion atlite/csp.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Expand Down
6 changes: 3 additions & 3 deletions atlite/cutout.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Base class for Atlite.
Base class for atlite.
"""

# There is a binary incompatibility between the pip wheels of netCDF4 and
Expand Down Expand Up @@ -68,7 +68,7 @@ class Cutout:

def __init__(self, path, **cutoutparams):
"""
Provide an Atlite cutout object.
Provide an atlite cutout object.
Create a cutout object to use atlite operations on it. Based on the
provided parameters, atlite first checks whether this cutout already
Expand Down
2 changes: 1 addition & 1 deletion atlite/data.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT
"""
Expand Down
4 changes: 2 additions & 2 deletions atlite/datasets/__init__.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# SPDX-FileCopyrightText: 2016 - 2023 The Atlite Authors
# SPDX-FileCopyrightText: Contributors to atlite <https://github.com/pypsa/atlite>
#
# SPDX-License-Identifier: MIT

"""
Atlite datasets.
atlite datasets.
"""

from atlite.datasets import era5, gebco, sarah
Expand Down
Loading

0 comments on commit 8bdae17

Please sign in to comment.