Skip to content

Commit 8ee4b9e

Browse files
authored
Merge branch 'main' into matlab_to_python
2 parents 2023833 + 31e7235 commit 8ee4b9e

7 files changed

Lines changed: 53 additions & 18 deletions

File tree

AUTHORS

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,14 @@ Miguel Dumett
1010
Joe Hellmers
1111
Arshia Ilaty
1212
Katayoon Kaviani
13+
Marc Loschen
1314
Oluchi Nzerem
1415
Giulia Pagallo
1516
Christopher Paolini
17+
Jiya Santosh Rathi
1618
Valentina Rosano
1719
Aneesh Murthy Srinivas
1820
Janani Priyadharshini Srinivasan
19-
Manuel Valera
21+
Manuel Valera
22+
Ben Wagner
23+
Deepanshu Zade

CITATION.cff

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,16 @@ authors:
2828
given-names: Arshia
2929
- family-names: Kaviani
3030
given-names: Katayoon
31+
- family-names: Loschen
32+
given-names: Marc
3133
- family-names: Nzerem
3234
given-names: Oluchi
3335
- family-names: Pagallo
3436
given-names: Giulia
3537
- family-names: Paolini
3638
given-names: Christopher
39+
- family-names: Rathi
40+
given-names: Jiya Santosh
3741
- family-names: Rosano
3842
given-names: Valentina
3943
- family-names: Srinivas
@@ -42,9 +46,13 @@ authors:
4246
given-names: Janani Priyadharshini
4347
- family-names: Valera
4448
given-names: Manuel
45-
doi: https://zenodo.org/records/16898575
46-
version: "1.1.0"
47-
date-released: "2025-08-13"
49+
- family-names: Wagner
50+
given-names: Ben
51+
- family-names: Zade
52+
given-names: Deepanshu
53+
doi: https://zenodo.org/records/20128874
54+
version: "1.2.0"
55+
date-released: "2026-05-08"
4856
url: https://mole-docs.readthedocs.io/en/main/
4957
repository: https://github.com/csrc-sdsu/mole
5058
preferred-citation:

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -204,20 +204,23 @@ The archival copy of the MOLE User Manual is maintained on [Zenodo](https://zeno
204204
Hellmers, Joe and
205205
Ilaty, Arshia and
206206
Kaviani, Katayoon and
207+
Loschen, Marc and
207208
Nzerem, Oluchi and
208209
Pagallo, Giulia and
209210
Paolini, Christopher and
211+
Rathi, Jiya and
210212
Rosano, Valentina and
211213
Srinivas, Aneesh Murthy and
212214
Srinivasan, Janani Priyadharshini and
213-
Valera, Manuel},
214-
title = {{MOLE User Manual}},
215-
month = aug,
216-
year = 2025,
217-
publisher = {Zenodo},
218-
version = {1.1.0},
219-
doi = {10.5281/zenodo.16898575},
220-
url = {https://doi.org/10.5281/zenodo.16898575},
215+
Valera, Manuel and
216+
Wagner, Ben and
217+
Zade, Deepanshu},
218+
title = {MOLE User Manual},
219+
month = may,
220+
year = 2026,
221+
publisher = {Zenodo},
222+
doi = {10.5281/zenodo.20128874},
223+
url = {https://doi.org/10.5281/zenodo.20128874},
221224
}
222225
```
223226

doc/sphinx/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
with open("../../../AUTHORS") as f:
3737
authorlist = f.readlines()
3838
author = ", ".join(authorlist)
39-
release = '1.1.0'
39+
release = '1.2.0'
4040
master_doc = 'index'
4141
root_doc = 'index'
4242

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,16 @@ We ideally want all release mechanics to be in one commit, which will then be ta
99

1010
Some minor bookkeeping updates are needed when releasing a new version of MOLE.
1111

12-
The version number must be updated in:
12+
The version number must be updated in the following files:
1313

14-
* `CITATION.cff` (update the `doi` field and `date-published` if needed)
15-
* `README.md` (if version-specific badges or information exist)
14+
* `mole/CITATION.cff`: update the `authors`, `doi`, and `date-released` fields if needed
15+
* `mole/README.md`: in the How to Cite section
16+
* `mole/doc/sphinx/source/conf.py`: the `release` field
1617

17-
Additionally, the release notes should be generated and reviewed.
18-
Use `git log --first-parent v1.0..` to get a sense of the pull requests that have been merged since the last release and thus might warrant emphasizing in the release notes.
18+
19+
Additionally, the change log should be generated and reviewed.
20+
21+
Use `git log --first-parent v1.0..` to get a sense of the pull requests that have been merged since the last release and thus might warrant emphasizing in the change log.
1922

2023
While doing this, gather a couple sentences for key features to highlight on [GitHub releases](https://github.com/csrc-sdsu/mole/releases).
2124

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Developer Notes
2+
3+
This section provides some notes useful for developers and maintainers of MOLE.
4+
5+
```{toctree}
6+
:maxdepth: 1
7+
:caption: Developer Releasing Notes
8+
9+
RELEASING
10+
```

doc/sphinx/source/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ Code of Conduct <intros/code_of_conduct_wrapper>
5656
Publications <intros/publications_wrapper>
5757
```
5858

59+
```{toctree}
60+
:maxdepth: 1
61+
:caption: Developer Notes
62+
:name: developer-nav
63+
dev-notes/index
64+
```
65+
5966
<!-- ```{toctree}
6067
:caption: Reference
6168
:hidden:

0 commit comments

Comments
 (0)