Skip to content

Commit 75e5111

Browse files
stevenhua0320stevenhua0320
authored
Untrack files and pyproject.toml edit (#9)
* edit AUTHORS.rst, CHANGELOG.rst, and CODE_OF_CONDUCT.rst * copyright for Michigan State University updated * update the license.rst and pyproject.toml
1 parent e6ff062 commit 75e5111

File tree

6 files changed

+324
-0
lines changed

6 files changed

+324
-0
lines changed

Diff for: ‎diffpy.srmise/AUTHORS.rst

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Authors
2+
=======
3+
4+
Luke Granlund
5+
Billinge Group and community contibutors.
6+
7+
Contributors
8+
------------
9+
10+
For a list of contributors, visit
11+
https://github.com/diffpy/diffpy.srmise/graphs/contributors

Diff for: ‎diffpy.srmise/CHANGELOG.rst

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
=============
2+
Release Notes
3+
=============
4+
5+
.. current developments

Diff for: ‎diffpy.srmise/CODE_OF_CONDUCT.rst

+133
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,133 @@
1+
=====================================
2+
Contributor Covenant Code of Conduct
3+
=====================================
4+
5+
Our Pledge
6+
----------
7+
8+
We as members, contributors, and leaders pledge to make participation in our
9+
community a harassment-free experience for everyone, regardless of age, body
10+
size, visible or invisible disability, ethnicity, sex characteristics, gender
11+
identity and expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, caste, color, religion, or sexual
13+
identity and orientation.
14+
15+
We pledge to act and interact in ways that contribute to an open, welcoming,
16+
diverse, inclusive, and healthy community.
17+
18+
Our Standards
19+
-------------
20+
21+
Examples of behavior that contributes to a positive environment for our
22+
community include:
23+
24+
* Demonstrating empathy and kindness toward other people
25+
* Being respectful of differing opinions, viewpoints, and experiences
26+
* Giving and gracefully accepting constructive feedback
27+
* Accepting responsibility and apologizing to those affected by our mistakes,
28+
and learning from the experience
29+
* Focusing on what is best not just for us as individuals, but for the overall
30+
community
31+
32+
Examples of unacceptable behavior include:
33+
34+
* The use of sexualized language or imagery, and sexual attention or advances of
35+
any kind
36+
* Trolling, insulting or derogatory comments, and personal or political attacks
37+
* Public or private harassment
38+
* Publishing others' private information, such as a physical or email address,
39+
without their explicit permission
40+
* Other conduct which could reasonably be considered inappropriate in a
41+
professional setting
42+
43+
Enforcement Responsibilities
44+
----------------------------
45+
46+
Community leaders are responsible for clarifying and enforcing our standards of
47+
acceptable behavior and will take appropriate and fair corrective action in
48+
response to any behavior that they deem inappropriate, threatening, offensive,
49+
or harmful.
50+
51+
Community leaders have the right and responsibility to remove, edit, or reject
52+
comments, commits, code, wiki edits, issues, and other contributions that are
53+
not aligned to this Code of Conduct, and will communicate reasons for moderation
54+
decisions when appropriate.
55+
56+
Scope
57+
-----
58+
59+
This Code of Conduct applies within all community spaces, and also applies when
60+
an individual is officially representing the community in public spaces.
61+
Examples of representing our community include using an official email address,
62+
posting via an official social media account, or acting as an appointed
63+
representative at an online or offline event.
64+
65+
Enforcement
66+
-----------
67+
68+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
69+
reported to the community leaders responsible for enforcement at
70+
[email protected]. All complaints will be reviewed and investigated promptly and fairly.
71+
72+
All community leaders are obligated to respect the privacy and security of the
73+
reporter of any incident.
74+
75+
Enforcement Guidelines
76+
----------------------
77+
78+
Community leaders will follow these Community Impact Guidelines in determining
79+
the consequences for any action they deem in violation of this Code of Conduct:
80+
81+
1. Correction
82+
****************
83+
84+
**Community Impact**: Use of inappropriate language or other behavior deemed
85+
unprofessional or unwelcome in the community.
86+
87+
**Consequence**: A private, written warning from community leaders, providing
88+
clarity around the nature of the violation and an explanation of why the
89+
behavior was inappropriate. A public apology may be requested.
90+
91+
2. Warning
92+
*************
93+
94+
**Community Impact**: A violation through a single incident or series of
95+
actions.
96+
97+
**Consequence**: A warning with consequences for continued behavior. No
98+
interaction with the people involved, including unsolicited interaction with
99+
those enforcing the Code of Conduct, for a specified period of time. This
100+
includes avoiding interactions in community spaces as well as external channels
101+
like social media. Violating these terms may lead to a temporary or permanent
102+
ban.
103+
104+
3. Temporary Ban
105+
******************
106+
107+
**Community Impact**: A serious violation of community standards, including
108+
sustained inappropriate behavior.
109+
110+
**Consequence**: A temporary ban from any sort of interaction or public
111+
communication with the community for a specified period of time. No public or
112+
private interaction with the people involved, including unsolicited interaction
113+
with those enforcing the Code of Conduct, is allowed during this period.
114+
Violating these terms may lead to a permanent ban.
115+
116+
4. Permanent Ban
117+
******************
118+
119+
**Community Impact**: Demonstrating a pattern of violation of community
120+
standards, including sustained inappropriate behavior, harassment of an
121+
individual, or aggression toward or disparagement of classes of individuals.
122+
123+
**Consequence**: A permanent ban from any sort of public interaction within the
124+
community.
125+
126+
Attribution
127+
-----------
128+
129+
This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>`_.
130+
131+
Community Impact Guidelines were inspired by `Mozilla's code of conduct enforcement ladder <https://github.com/mozilla/inclusion>`_.
132+
133+
For answers to common questions about this code of conduct, see the `FAQ <https://www.contributor-covenant.org/faq>`_. `Translations are available <https://www.contributor-covenant.org/translations>`_

Diff for: ‎diffpy.srmise/LICENSE.rst

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
BSD 3-Clause License
2+
3+
Copyright (c) 2014-2015, Board of Trustees of Michigan State University
4+
2016-2024, The Trustees of Columbia University in the City of New York.
5+
All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without
8+
modification, are permitted provided that the following conditions are met:
9+
10+
1. Redistributions of source code must retain the above copyright notice, this
11+
list of conditions and the following disclaimer.
12+
13+
2. Redistributions in binary form must reproduce the above copyright notice,
14+
this list of conditions and the following disclaimer in the documentation
15+
and/or other materials provided with the distribution.
16+
17+
3. Neither the name of the copyright holder nor the names of its contributors
18+
may be used to endorse or promote products derived from this software
19+
without specific prior written permission.
20+
21+
If you use this program to do productive scientific research that
22+
leads to publication, we ask that you acknowledge use of the
23+
program by citing the following paper in your publication:
24+
25+
L. Granlund, S.J.L. Billinge, P.M. Duxbury, Algorithm for
26+
systematic peak extraction from atomic pair distribution
27+
functions, Acta Crystallographica A 71(4), 392-409 (2015).
28+
doi:10.1107/S2053273315005276
29+
30+
For more information please visit the diffpy web-page at
31+
http://www.diffpy.org
32+
or email Luke Granlund at [email protected], or Prof. Simon
33+
Billinge at [email protected].
34+
35+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
36+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
37+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
39+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
40+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
41+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
42+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
43+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
44+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Diff for: ‎diffpy.srmise/doc/source/license.rst

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
:tocdepth: -1
2+
3+
.. index:: license
4+
5+
License
6+
#######
7+
8+
OPEN SOURCE LICENSE AGREEMENT
9+
=============================
10+
BSD 3-Clause License
11+
12+
Copyright (c)
13+
Copyright (c) 2014-2015, Board of Trustees of Michigan State University
14+
2016-2024, The Trustees of Columbia University in the City of New York.
15+
All Rights Reserved.
16+
17+
Redistribution and use in source and binary forms, with or without
18+
modification, are permitted provided that the following conditions are met:
19+
20+
1. Redistributions of source code must retain the above copyright notice, this
21+
list of conditions and the following disclaimer.
22+
23+
2. Redistributions in binary form must reproduce the above copyright notice,
24+
this list of conditions and the following disclaimer in the documentation
25+
and/or other materials provided with the distribution.
26+
27+
3. Neither the name of the copyright holder nor the names of its
28+
contributors may be used to endorse or promote products derived from
29+
this software without specific prior written permission.
30+
31+
If you use this program to do productive scientific research that
32+
leads to publication, we ask that you acknowledge use of the
33+
program by citing the following paper in your publication:
34+
35+
L. Granlund, S.J.L. Billinge, P.M. Duxbury, Algorithm for
36+
systematic peak extraction from atomic pair distribution
37+
functions, Acta Crystallographica A 71(4), 392-409 (2015).
38+
doi:10.1107/S2053273315005276
39+
40+
For more information please visit the diffpy web-page at
41+
http://www.diffpy.org
42+
or email Luke Granlund at [email protected], or Prof. Simon
43+
Billinge at [email protected].
44+
45+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
46+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
48+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
49+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
51+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
52+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
53+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
54+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Diff for: ‎diffpy.srmise/pyproject.toml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
[build-system]
2+
requires = ["setuptools>=62.0", "setuptools-git-versioning<2"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "diffpy.srmise"
7+
dynamic=['version']
8+
authors = [
9+
{ name="Simon J.L. Billinge group", email="[email protected]" },
10+
{name="Luke Granlund", email="[email protected]"}
11+
]
12+
maintainers = [
13+
{ name="Simon J.L. Billinge group", email="[email protected]" },
14+
]
15+
description = "Peak extraction/fitting tool for pair distribution functions"
16+
keywords = ['peak extraction fitting PDF AIC multimodeling']
17+
readme = "README.rst"
18+
requires-python = ">=3.10"
19+
classifiers = [
20+
# List of possible values at
21+
# http://pypi.python.org/pypi?:action=list_classifiers
22+
'Development Status :: 3 - Alpha',
23+
'Environment :: Console',
24+
'Intended Audience :: Developers',
25+
'Intended Audience :: Education',
26+
'Intended Audience :: Science/Research',
27+
'License :: OSI Approved :: BSD License',
28+
'Operating System :: MacOS :: MacOS X',
29+
'Operating System :: Microsoft :: Windows',
30+
'Operating System :: POSIX',
31+
'Operating System :: Unix',
32+
'Programming Language :: Python :: 3.10',
33+
'Programming Language :: Python :: 3.11',
34+
'Programming Language :: Python :: 3.12',
35+
'Topic :: Scientific/Engineering :: Physics',
36+
'Topic :: Scientific/Engineering :: Chemistry',
37+
'Topic :: Software Development :: Libraries',
38+
]
39+
40+
[project.urls]
41+
Homepage = "https://github.com/diffpy/diffpy.srmise/"
42+
Issues = "https://github.com/diffpy/diffpy.srmise/issues/"
43+
44+
[tool.setuptools-git-versioning]
45+
enabled = true
46+
template = "{tag}"
47+
dev_template = "{tag}"
48+
dirty_template = "{tag}"
49+
50+
[tool.setuptools.packages.find]
51+
where = ["src"] # list of folders that contain the packages (["."] by default)
52+
include = ["*"] # package names should match these glob patterns (["*"] by default)
53+
exclude = ["diffpy.srmise.tests*"] # exclude packages matching these glob patterns (empty by default)
54+
namespaces = false # to disable scanning PEP 420 namespaces (true by default)
55+
56+
[tool.black]
57+
line-length = 115
58+
include = '\.pyi?$'
59+
exclude = '''
60+
/(
61+
\.git
62+
| \.hg
63+
| \.mypy_cache
64+
| \.tox
65+
| \.venv
66+
| \.rst
67+
| \.txt
68+
| _build
69+
| buck-out
70+
| build
71+
| dist
72+
73+
# The following are specific to Black, you probably don't want those.
74+
| blib2to3
75+
| tests/data
76+
)/
77+
'''

0 commit comments

Comments
 (0)