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

update master from PlasmaPy master #2

Merged
merged 24 commits into from Jun 11, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
303e3b2
allow decorators `check_quantity` and `check_relativistic` to preserv…
rocco8773 May 8, 2019
a8a7627
add __signature__ to particle_input
StanczakDominik May 8, 2019
efd7bff
Presevering function hints when decorated by `check_quantity` and `ch…
StanczakDominik May 8, 2019
d958653
[WIP] Particle drifts (#484)
StanczakDominik May 20, 2019
24113f1
Langmuir example improvement (#623)
StanczakDominik May 20, 2019
aeae43b
Delete development roadmap
namurphy May 30, 2019
2d30a70
Add file with metadata for Zenodo upload
namurphy May 30, 2019
342fc02
Delete development roadmap (#627)
StanczakDominik May 31, 2019
855bbc6
Add file with metadata for Zenodo upload (#628)
StanczakDominik May 31, 2019
99264c9
Metadata updates prior to version 0.2.0 (#629)
namurphy May 31, 2019
5fe15de
Improve feedbackability (#626)
StanczakDominik May 31, 2019
cb4a183
Begin updating change log for 0.2.0
namurphy May 31, 2019
04c0134
Add further changelog entries
StanczakDominik May 31, 2019
bf35562
Update change log for release of version 0.2.0 (#631)
StanczakDominik May 31, 2019
5b2e851
Update version number
StanczakDominik May 31, 2019
99ac40a
Make docs makefile version-agnostic
StanczakDominik May 31, 2019
7d3f549
Add mailmap file
StanczakDominik May 31, 2019
abb1d1b
Update credits
StanczakDominik May 31, 2019
9ce17c1
Update release notes
StanczakDominik May 31, 2019
64d723d
possibly fix lack of JSON in sdist
StanczakDominik May 31, 2019
c5222de
Update release guide
StanczakDominik May 31, 2019
19a681f
Update setup.py classifiers for PyPI
StanczakDominik May 31, 2019
1c874ea
post v0.2.0 cleanup (#633)
StanczakDominik May 31, 2019
6afe25f
Fix typo in link
StanczakDominik Jun 6, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
54 changes: 54 additions & 0 deletions .mailmap
@@ -0,0 +1,54 @@
Nick Murphy <namurphy@cfa.harvard.edu> <namurphy@users.noreply.github.com>
Dominik Stańczak <stanczakdominik@gmail.com>
Pawel Marek Kozlowski <pawel@pmkozlowski.com>
samurai688 <sam.langendorf@gmail.com>
ritiek <ritiekmalhotra123@gmail.com>
Drew Leonard <andy.j.leonard@gmail.com>
Nick Murphy
David Stansby <dstansby@gmail.com>
Julien Hillairet <julien.hillaire@cea.fr> <julien.hillairet@gmail.com>
Roberto Díaz Pérez <r.r.1994a@gmail.com>
Thomas Fan <thomasjpfan@gmail.com>
jasperbeckers <j.p.beckers@student.tue.nl>
Jasper Beckers <j.p.beckers@student.tue.nl>
Colby Haggerty <colbych@udel.edu>
Pawel Kozlowski <pawel@pmkozlowski.com>
jams2 <me@joshuamunn.com>
Manas Bedmutha <manasbedmutha98@gmail.com>
Piotr Kuszaj <peterkuszaj@gmail.com>
Apoorv Choubey <theapoorvs1@gmail.com>
Ritiek Malhotra <ritiekmalhotra123@gmail.com>
pohzipohzi <poh.zihow@gmail.com>
Michael Fischer <michael.fischer.13@cnu.edu>
Antoine T <antoine.tavant@lpp.polytechnique.fr>
Ludovico_Bessi <ludovicobessi@gmail.com>
Siddharth <think.siddharth@gmail.com>
Stuart Mumford <stuart@cadair.com>
nrb1324 <nrb1324@hotmail.com>
Dawa Nurbu Sherpa <dawa@Dawas-MacBook-Pro.local>
Nabil Humphrey <nabilhumphrey@internode.on.net>
Poh Zi How <poh.zihow@gmail.com>
Sean Carroll <seanwilliamcarroll@gmail.com>
Thomas Ulrich <tmulrich1@gmail.com>
cclauss <cclauss@bluewin.ch>
hzxusx <hzxusx@gmail.com>
lgoenner <lgoenner@users.noreply.github.com>
misupova <marija.isupova@gmail.com>
Ankit Singh <Griffintaur@users.noreply.github.com> <ankitsingh135@gmail.com>
BH4 <brycefore4@gmail.com>
Brigitta Sipocz <bsipocz@gmail.com>
Carol Zhang <carol.zhang@mail.mcgill.ca>
Chengcai Shen <chengcaishen@cfa.harvard.edu>
Francisco Silva Pavon <silvapav@usc.edu>
Graham Goudeau <grahamgoudeau@gmail.com>
Jacob Deal <38059243+Jac0bDeal@users.noreply.github.com>
Justin Bergeron <bergeron.just@gmail.com>
Leah <leaheinhorn@Leahs-MacBook-Air.local> <leaheinhorn@yahoo.com>
Neil Patel <neil123@gmail.com>
Nismirno <daemonik92@yahoo.com>
Raajit Raj <raajit.raj@gmail.com>
Samaiyah I. Farid <38890767+samaiyahfarid@users.noreply.github.com>
Sean Chambers <schambers80@gmail.com>
Yi-Min Huang <yopology@yahoo.com>
rocco8773 <eteverson@gmail.com>
savcheva <43857770+savcheva@users.noreply.github.com>
177 changes: 177 additions & 0 deletions .zenodo.json
@@ -0,0 +1,177 @@
{
"creators": [
{
"name": "PlasmaPy Community"
},
{
"name": "Murphy, Nicholas A.",
"affiliation": "Center for Astrophysics | Harvard & Smithsonian",
"orcid": "0000-0001-6628-8033"
},
{
"name": "Stańczak, Dominik",
"affiliation": "University of Warsaw",
"orcid": "0000-0001-6291-8843"
},
{
"name": "Kozlowski, Pawel M.",
"affiliation": "Los Alamos National Laboratory",
"orcid": "0000-0001-6849-3612"
},
{
"name": "Malhotra, Ritiek",
"affiliation": "Chandigarh University"
},
{
"name": "Langendorf, Samuel J.",
"affiliation": "Los Alamos National Laboratory",
"orcid": "0000-0002-7757-5879"
},
{
"name": "Leonard, Andrew J.",
"affiliation": "Aperio Software",
"orcid": "0000-0001-5270-7487"
},
{
"name": "Stansby, David",
"affiliation": "Imperial College London",
"orcid": "0000-0002-1365-1908"
},
{
"name": "Haggerty, Colby C.",
"affiliation": "University of Chicago"
},
{
"name": "Mumford, Stuart J.",
"affiliation": "University of Sheffield",
"orcid": "0000-0003-4217-4642"
},
{
"name": "Beckers, Jasper P.",
"affiliation": "ASML"
},
{
"name": "Bedmutha, Manas Satish"
},
{
"name": "Bergeron, Justin"
},
{
"name": "Bessi, Ludovico"
},
{
"name": "Carroll, Sean"
},
{
"name": "Chambers, Sean"
},
{
"name": "Choubey, Apoorv"
},
{
"name": "Deal, Jacob"
},
{
"name": "Díaz Pérez, Roberto"
},
{
"name": "Einhorn, Leah"
},
{
"name": "Everson, Eric",
"affiliation": "UCLA"
},
{
"name": "Fan, Thomas"
},
{
"name": "Farid, Samaiyah I.",
"affiliation": "Center for Astrophysics | Harvard & Smithsonian"
},
{
"name": "Goudeau, Graham"
},
{
"name": "Guidoni, Silvina",
"affiliation": "American University"
},
{
"name": "Hillairet, Julien",
"orcid": "0000-0002-1073-6383"
},
{
"name": "How, Poh Zi"
},
{
"name": "Huang, Yi-Min",
"affiliation": "Princeton University",
"orcid": "0000-0002-4237-2211"
},
{
"name": "Humphrey, Nabil"
},
{
"name": "Isupova, Maria"
},
{
"name": "Kulshrestha, Siddharth"
},
{
"name": "Kuszaj, Piotr"
},
{
"name": "Munn, Joshua"
},
{
"name": "Parashar, Tulasi",
"affiliation": "University of Delaware",
"orcid": "0000-0003-0602-8381"
},
{
"name": "Patel, Neil"
},
{
"name": "Raj, Raajit"
},
{
"name": "Savcheva, Antonia",
"affiliation": "Center for Astrophysics | Harvard & Smithsonian",
"orcid": "0000-0002-5598-046X"
},
{
"name": "Shen, Chengcai",
"affiliation": "Center for Astrophysics | Harvard & Smithsonian"
},
{
"name": "Sherpa, Dawa Nurbu"
},
{
"name": "Silva, Frank"
},
{
"name": "Singh, Ankit"
},
{
"name": "Sipőcz, Brigitta",
"orcid": "0000-0002-3713-6337"
},
{
"name": "Tavant, Antoine",
"affiliation": "Laboratoire de Physique des Plasmas, Ecole Polytechnique",
"orcid": "0000-0003-0010-8073"
},
{
"name": "Xu, Sixue"
},
{
"name": "Zhang, Carol"
}
],
"keywords": [
"plasma physics",
"Python",
"open source"
],
"license": "BSD+Patent",
"upload_type": "software"
}
63 changes: 31 additions & 32 deletions CITATION.rst
Expand Up @@ -2,41 +2,40 @@ Acknowledging and Citing PlasmaPy
=================================

If you use PlasmaPy for a project resulting in a publication, we ask
that you cite the following reference (`BibTeX
<https://zenodo.org/record/1238132/export/hx#.WvMkQK0cChc>`_):
that you cite both the specific version of PlasmaPy used in your
project and an informational reference. Including these references
provides credit to developers of PlasmaPy and enables greater
scientific reproducibility.

Version 0.2.0 of PlasmaPy may be cited using the following reference.

* PlasmaPy Community et al. (2019). *PlasmaPy version 0.2.0*, Zenodo,
https://doi.org/10.5281/zenodo.3235817

The current standard informational reference for PlasmaPy is

* PlasmaPy Community, Nicholas A. Murphy, Andrew J. Leonard, Dominik
Stańczak, Pawel M. Kozlowski, Samuel J. Langendorf, Colby C. Haggerty,
Jasper P. Beckers, Stuart J. Mumford, Tulasi N. Parashar, and Yi-Min
Huang. (2018, April). *PlasmaPy: an open source community-developed
Python package for plasma physics.* Zenodo.
http://doi.org/10.5281/zenodo.1238132

We provide the following standard acknowledgment that you may use
instead of a citation in the body of a paper.

* This research made use of PlasmaPy, a community-developed open source
core Python package for plasma physics (PlasmaPy Community 2018).

The source code for the most recent release of PlasmaPy (version
0.1.1) is archived on `Zenodo
<https://zenodo.org/communities/plasmapy>`__ and can be cited using
the following reference (`BibTeX
<https://zenodo.org/record/1436019/export/hx#.W6wUbxxG2Pc>`__):

* PlasmaPy Community, Nicholas A. Murphy, Dominik Stańczak,
Pawel M. Kozlowski, Samuel J. Langendorf, Andrew J. Leonard,
Jasper P. Beckers, Colby C. Haggerty, Stuart J. Mumford, Ritiek
Malhotra, Ludovico Bessi, Sean Carroll, Apoorv Choubey, Roberto Díaz
Pérez, Leah Einhorn, Thomas Fan, Graham Goudeau, Silvina Guidoni,
Julien Hillairet, Poh Zi How, Yi-Min Huang, Nabil Humphrey, Maria
Isupova, Siddharth Kulshrestha, Piotr Kuszaj, Joshua Munn, Tulasi
Parashar, Neil Patel, Raajit Raj, Dawa Nurbu Sherpa, David Stansby,
Antoine Tavant, and Sixue Xu. (2018, May 27). *PlasmaPy* (Version
0.1.1). Zenodo. http://doi.org/10.5281/zenodo.1436019

We highly encourage researchers to acknowledge the packages that
PlasmaPy depends on, including but not limited to
`Astropy <https://www.astropy.org/acknowledging.html>`__,
Huang. (2018). *PlasmaPy: an open source community-developed
Python package for plasma physics*, Zenodo,
https://doi.org/10.5281/zenodo.1238132

These references may be made by adding the following line to the
methods or acknowledgements sections of a paper.

* This research made use of PlasmaPy version 0.2.0, a
community-developed open source Python package for plasma
physics (PlasmaPy Community et al. 2018, 2019).

All public releases of PlasmaPy are openly archived in the `PlasmaPy
Community <https://zenodo.org/communities/plasmapy>`__ on `Zenodo
<https://zenodo.org>`__.

We encourage authors to acknowledge the packages that PlasmaPy
depends on, including but not limited to
`Astropy <https://www.astropy.org/acknowledging.html>`__,
`NumPy <https://www.scipy.org/citing.html#numpy>`__, and
`SciPy <https://www.scipy.org/citing.html#scipy-the-library>`__.


5 changes: 0 additions & 5 deletions INSTALL.md

This file was deleted.

32 changes: 26 additions & 6 deletions README.md
Expand Up @@ -33,17 +33,37 @@ and have a [Code of
Conduct](http://plasmapy.readthedocs.io/en/master/CODE_OF_CONDUCT.html).
New contributors are very welcome!

# Feedback and communication

## [Matrix chat](https://riot.im/app/#/room/#plasmapy:matrix.org)

If you have any questions, the quickest way to get a response is to ask
on our
[Matrix](https://riot.im/app/#/room/#plasmapy:matrix.org)/[Gitter](https://gitter.im/PlasmaPy/Lobby)
channel. For a slower response, you may also contact Nick Murphy at
<namurphy@cfa.harvard.edu> and Drew Leonard at
<andy.j.leonard@gmail.com>. You may also [sign up for PlasmaPy's email
list](https://groups.google.com/forum/#!forum/plasmapy).
channel.

## [Mailing list](https://groups.google.com/forum/#!forum/plasmapy)

We also have a [mailing list](https://groups.google.com/forum/#!forum/plasmapy)
that serves as a less volatile discussion forum.

## [Suggestion box](https://docs.google.com/forms/d/e/1FAIpQLSdT3O5iHZrLJRuavFyzoR23PGy0Prfzx2SQOcwJGWtvHyT2lw/viewform?usp=sf_link)

We have
[a suggestion box](https://docs.google.com/forms/d/e/1FAIpQLSdT3O5iHZrLJRuavFyzoR23PGy0Prfzx2SQOcwJGWtvHyT2lw/viewform?usp=sf_link)
if you would like to (optionally anonymously) suggest
a feature/topic for consideration. These will be reposted on the mailing list
or directly in GitHub issues, as appropriate, for further discussion.

## [Biweekly](https://calendar.google.com/calendar?cid=bzVsb3ZkcW0zaWxsam00ZTlrMDd2cmw5bWdAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) [video calls](https://meet.jit.si/plasmapy)

We also have approximately bi-weekly online meetings at [Jitsi](https://meet.jit.si/plasmapy), for which we have a [calendar here](https://calendar.google.com/calendar?cid=bzVsb3ZkcW0zaWxsam00ZTlrMDd2cmw5bWdAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) and [written meeting notes here](https://drive.google.com/drive/folders/0ByPG8nie6fTPV1FQUEkzMTgtRTg?usp=sharing). Come discuss plasma software with us!
We also have approximately bi-weekly online meetings at
[Jitsi](https://meet.jit.si/plasmapy), for which we have a
[calendar here](https://calendar.google.com/calendar?cid=bzVsb3ZkcW0zaWxsam00ZTlrMDd2cmw5bWdAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ)
and [written meeting notes here](https://drive.google.com/drive/folders/0ByPG8nie6fTPV1FQUEkzMTgtRTg?usp=sharing).
Come discuss plasma software with us!

## Installation
# Installation

You can get PlasmaPy from pip via `pip install plasmapy`. To contribute
to the package, check out [our instructions on installing PlasmaPy from
Expand Down