Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add list of authors to the repo and the docs #461

Merged
merged 10 commits into from
Nov 24, 2020
19 changes: 19 additions & 0 deletions AUTHORS.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Authors and Developers
======================

The following persons contributed to the development of the |pyam| framework:

- Matthew Gidden `@gidden <https://github.com/gidden>`_
- Daniel Huppmann `@danielhuppmann <https://github.com/danielhuppmann>`_,
`iiasa <https://www.iiasa.ac.at/staff/huppmann>`_
- Zebedee Nicholls `@znicholls <https://github.com/znicholls>`_
- Nikolay Kushin `@zikolach <https://github.com/zikolach>`_
- Robin Lamboll `@Rlamboll <https://github.com/Rlamboll>`_
- Oliver Fricko `@OFR-IIASA <https://github.com/OFR-IIASA>`_
- Jonas Hörsch `@coroa <https://github.com/coroa>`_
- Paul Natsuo Kishimoto `@khaeru <https://github.com/khaeru>`_
- Thorsten Burandt `@tburandt <https://github.com/tburandt>`_
- Ross Ursino `@rossursino <https://github.com/rossursino>`_
- Maik Budzinski `@mabudz <https://github.com/mabudz>`_
- Jarmo Kikstra `@jkikstra <https://github.com/jkikstra>`_
- Michael Pimmer `@fonfon <https://github.com/fonfon>`_
27 changes: 0 additions & 27 deletions LICENSE
Original file line number Diff line number Diff line change
Expand Up @@ -172,30 +172,3 @@
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2018 Matthew J. Gidden and Daniel Huppmann

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
4 changes: 2 additions & 2 deletions NOTICE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Copyright 2017-2018 IIASA Energy Program
Copyright 2017-2020 IIASA and the pyam developer team

The `pyam` package is licensed under
The **pyam** package is licensed under
the Apache License, Version 2.0 (the "License");
you may not use the package except in compliance with the License.
You may obtain a copy of the License at
Expand Down
1 change: 1 addition & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

- [ ] Tests Added
- [ ] Documentation Added
- [ ] Name of contributors Added to AUTHORS.rst
- [ ] Description in RELEASE_NOTES.md Added

## Adding to RELEASE_NOTES.md (remove section after adding to RELEASE_NOTES.md)
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
pyam: analysis & visualization <br /> of integrated-assessment scenarios
========================================================================

[![license](https://anaconda.org/conda-forge/pyam/badges/license.svg)](https://anaconda.org/conda-forge/pyam)
[![license](https://img.shields.io/badge/License-Apache%202.0-black)](https://github.com/IAMconsortium/pyam/blob/master/LICENSE)
[![pypi](https://img.shields.io/pypi/v/pyam-iamc.svg)](https://pypi.python.org/pypi/pyam-iamc/)
[![conda](https://anaconda.org/conda-forge/pyam/badges/version.svg)](https://anaconda.org/conda-forge/pyam)
[![latest](https://anaconda.org/conda-forge/pyam/badges/latest_release_date.svg)](https://anaconda.org/conda-forge/pyam)
Expand Down Expand Up @@ -83,7 +83,7 @@ and Daniel Huppmann ([@danielhuppmann](https://github.com/danielhuppmann/)).
License
-------

Copyright 2017-2020 IIASA Energy Program
Copyright 2017-2020 IIASA and the pyam developer team

The **pyam** package is licensed
under the Apache License, Version 2.0 (the "License");
Expand Down
1 change: 1 addition & 0 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Individual updates

- [#461](https://github.com/IAMconsortium/pyam/pull/461) Add list of authors to repo and docs pages
- [#459](https://github.com/IAMconsortium/pyam/pull/459) Add a `get_variable_components()` function to retrieve or join variable components
- [#458](https://github.com/IAMconsortium/pyam/pull/458) Enable `Path` for IamDataFrame initialization
- [#454](https://github.com/IAMconsortium/pyam/pull/454) Enable dimensionless units and fix `info()` if IamDataFrame is empty
Expand Down
2 changes: 2 additions & 0 deletions RELEASE_PROCEDURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@

1. Make a release candidate branch (e.g., `rc_v<release version>`)
and pull request it into `master` with the following updates:
1. If it's the first release in a new year,
search for `Copyright 2017` and bump the year
1. Deprecate any stated portion of the API
(you can find them by searching the code base for "deprecate")
1. Update `RELEASE_NOTES.md` (see the examples of previous releases)
Expand Down
1 change: 1 addition & 0 deletions doc/source/authors.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.. include:: ../../AUTHORS.rst
4 changes: 2 additions & 2 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@
# General information about the project.
project = u'pyam'
year = datetime.now().year
copyright = '{}, Matthew Gidden & Daniel Huppmann'.format(year)
author = u'Matthew Gidden & Daniel Huppmann'
copyright = '{}, IIASA and the pyam developer team'.format(year)
author = u'pyam developer team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
Expand Down
19 changes: 14 additions & 5 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Release v\ |version|.

|joss| |doi|

.. |license| image:: https://anaconda.org/conda-forge/pyam/badges/license.svg
:target: https://anaconda.org/conda-forge/pyam
.. |license| image:: https://img.shields.io/badge/License-Apache%202.0-black
:target: https://github.com/IAMconsortium/pyam/blob/master/LICENSE

.. |pypi| image:: https://img.shields.io/pypi/v/pyam-iamc.svg
:target: https://pypi.python.org/pypi/pyam-iamc/
Expand Down Expand Up @@ -77,19 +77,28 @@ Table of Contents
:maxdepth: 2

install
authors
contributing
data
tutorials
examples/index
api

License
-------
Copyright & License
-------------------

The development of the |pyam| package was started at the IIASA Energy Program,
with contributions from a number of `individuals & institutions`_ over the years.

|pyam| is available under the open source `Apache License`_.
The package is available under the open-source `Apache License`_.
Refer to the `NOTICE`_ in the GitHub repository for more information.

.. _individuals & institutions: authors.html

.. _Apache License: http://www.apache.org/licenses/LICENSE-2.0.html

.. _NOTICE: https://github.com/IAMconsortium/pyam/blob/master/NOTICE.md

Scientific reference
--------------------

Expand Down