Skip to content

Commit dbd7d53

Browse files
committed
chore: add back necessary lines from the files
1 parent de23201 commit dbd7d53

File tree

7 files changed

+104
-19
lines changed

7 files changed

+104
-19
lines changed

AUTHORS.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Authors
22
=======
33

4-
Simon J.L. Billinge group
4+
Billinge Group and community contributors.
55

66
Contributors
77
------------

CHANGELOG.rst

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,50 @@ Release notes
33
=============
44

55
.. current developments
6+
7+
0.1.3
8+
=====
9+
10+
**Fixed:**
11+
12+
* Updated README instructions for pip and conda-forge install
13+
* Updated README instructions to check for successful installation
14+
15+
16+
0.1.2
17+
=====
18+
19+
**Added:**
20+
21+
* Use GitHub Actions to build, release, upload to PyPI
22+
* Added issue template for PyPI/GitHub release
23+
24+
**Changed:**
25+
26+
* Added tag check for release
27+
* citation from arXiv to npj Comput Mater in docs
28+
29+
**Fixed:**
30+
31+
* Python version from 3.9 to 3.12 in CI news item
32+
* tests folder at the root of the repo
33+
* re-cookiecuter repo to groupd's package standard
34+
* Add pip dependencies under pip.txt and conda dependencies under conda.txt
35+
36+
37+
0.1.0
38+
=====
39+
40+
**Added:**
41+
42+
* Initial release of diffpy.snmf
43+
44+
**Changed:**
45+
46+
* Support Python version 3.12
47+
* Remove support for Python version 3.9
48+
49+
**Fixed:**
50+
51+
* Repo structure modified to the new diffpy standard
52+
* Code linting based on .pre-commit-config.yaml

LICENSE.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License
22

3-
Copyright (c) 2025, The Trustees of Columbia University in the City of New York.
3+
Copyright (c) 2024-2025, The Trustees of Columbia University in the City of New York.
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Support and Contribute
9999

100100
`Diffpy user group <https://groups.google.com/g/diffpy-users>`_ is the discussion forum for general questions and discussions about the use of diffpy.snmf. Please join the diffpy.snmf users community by joining the Google group. The diffpy.snmf project welcomes your expertise and enthusiasm!
101101

102-
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.snmf/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.snmf/pulls>`_.
102+
If you see a bug or want to request a feature, please `report it as an issue <https://github.com/diffpy/diffpy.snmf/issues>`_ and/or `submit a fix as a PR <https://github.com/diffpy/diffpy.snmf/pulls>`_. You can also post it to the `Diffpy user group <https://groups.google.com/g/diffpy-users>`_.
103103

104104
Feel free to fork the project and contribute. To install diffpy.snmf
105105
in a development mode, with its sources being directly used by Python

doc/source/api/diffpy.snmf.rst

Lines changed: 52 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,68 @@
11
:tocdepth: -1
22

3-
|title|
4-
=======
5-
6-
.. |title| replace:: diffpy.snmf package
3+
diffpy.snmf package
4+
===================
75

86
.. automodule:: diffpy.snmf
97
:members:
108
:undoc-members:
119
:show-inheritance:
1210

13-
Subpackages
14-
-----------
15-
16-
.. toctree::
17-
diffpy.snmf.example_package
18-
1911
Submodules
2012
----------
2113

22-
|module|
23-
--------
14+
diffpy.snmf.subroutines module
15+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16+
17+
.. automodule:: diffpy.snmf.subroutines
18+
:members:
19+
:undoc-members:
20+
:show-inheritance:
21+
22+
diffpy.snmf.containers module
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
24+
25+
.. automodule:: diffpy.snmf.containers
26+
:members:
27+
:undoc-members:
28+
:show-inheritance:
29+
30+
diffpy.snmf.io module
31+
^^^^^^^^^^^^^^^^^^^^^
32+
33+
.. automodule:: diffpy.snmf.io
34+
:members:
35+
:undoc-members:
36+
:show-inheritance:
37+
38+
diffpy.snmf.polynomials module
39+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40+
41+
.. automodule:: diffpy.snmf.polynomials
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:
45+
46+
diffpy.snmf.optimizers module
47+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
48+
49+
.. automodule:: diffpy.snmf.optimizers
50+
:members:
51+
:undoc-members:
52+
:show-inheritance:
53+
54+
diffpy.snmf.factorizers module
55+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
56+
57+
.. automodule:: diffpy.snmf.factorizers
58+
:members:
59+
:undoc-members:
60+
:show-inheritance:
2461

25-
.. |module| replace:: diffpy.snmf.example_submodule module
62+
diffpy.snmf.stretchednmfapp module
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2664

27-
.. automodule:: diffpy.snmf.example_submodule
65+
.. automodule:: diffpy.snmf.stretchednmfapp
2866
:members:
2967
:undoc-members:
3068
:show-inheritance:

doc/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
sys.path.insert(0, str(Path("../../src").resolve()))
3333

3434
# abbreviations
35-
ab_authors = "Simon J.L. Billinge group"
35+
ab_authors = "Billinge Group members and community contributors"
3636

3737
# -- General configuration ------------------------------------------------
3838

doc/source/license.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ OPEN SOURCE LICENSE AGREEMENT
99
=============================
1010
BSD 3-Clause License
1111

12-
Copyright (c) 2025, The Trustees of Columbia University in the City of New York.
12+
Copyright (c) 2024-2025, The Trustees of Columbia University in the City of New York.
1313
All Rights Reserved.
1414

1515
Redistribution and use in source and binary forms, with or without

0 commit comments

Comments
 (0)