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 Docs #72

Merged
merged 7 commits into from
Nov 8, 2024
Merged

Update Docs #72

merged 7 commits into from
Nov 8, 2024

Conversation

marcelmbn
Copy link
Member

@marcelmbn marcelmbn commented Nov 7, 2024

Updates towards:

  • co-worker annotations
  • pyproject.toml (Python versions, license, authors)
  • remove typos
  • mindlessgen.toml: explanations updated

Fixed inconsistent default values

@marcelmbn marcelmbn added the documentation Improvements or additions to documentation label Nov 7, 2024
@marcelmbn marcelmbn added this to the v1.0.0 milestone Nov 7, 2024
@marcelmbn marcelmbn self-assigned this Nov 7, 2024
@marcelmbn marcelmbn linked an issue Nov 8, 2024 that may be closed by this pull request
Signed-off-by: Marcel Müller <[email protected]>
Signed-off-by: Marcel Müller <[email protected]>
Signed-off-by: Marcel Müller <[email protected]>
Signed-off-by: Marcel Müller <[email protected]>
Signed-off-by: Marcel Müller <[email protected]>
@marcelmbn marcelmbn merged commit 37913dd into grimme-lab:main Nov 8, 2024
10 checks passed
@marcelmbn marcelmbn deleted the docs/update_Nov24 branch November 8, 2024 09:11
marcelmbn added a commit that referenced this pull request Nov 18, 2024
* Update Docs (#72)

* update docs, co-workers, pyproject.toml, remove typos

Signed-off-by: Marcel Müller <[email protected]>

* update CHANGELOG, make case more consistent

Signed-off-by: Marcel Müller <[email protected]>

* update mindlessgen.toml

Signed-off-by: Marcel Müller <[email protected]>

* align defaults

Signed-off-by: Marcel Müller <[email protected]>

* update reference default value

Signed-off-by: Marcel Müller <[email protected]>

* update tests

Signed-off-by: Marcel Müller <[email protected]>

* correct inconsistent boolean

Signed-off-by: Marcel Müller <[email protected]>

---------

Signed-off-by: Marcel Müller <[email protected]>

* Fix random number generation by removing legacy random number generation (#78)

* fix random number generation by incorporating default_rng

Signed-off-by: Marcel Müller <[email protected]>

* update CHANGELOG.md

Signed-off-by: Marcel Müller <[email protected]>

---------

Signed-off-by: Marcel Müller <[email protected]>

* Remove deprecated tests that are not strictly true (#79)

* remove deprecated tests

Signed-off-by: Marcel Müller <[email protected]>

* remove random numpy seed as it's pointless now

Signed-off-by: Marcel Müller <[email protected]>

---------

Signed-off-by: Marcel Müller <[email protected]>

* A fixed molecular charge for the molecule generation. (#73)

* A new function to set a fixed charge value

Signed-off-by: Jonathan Schöps <[email protected]>

* latest changes to the fixed charge method

Signed-off-by: Jonathan Schöps <[email protected]>

* Fixed charge and element composition works test have to be added

Signed-off-by: Jonathan Schöps <[email protected]>

* More modular fixed charge routine

Signed-off-by: Jonathan Schöps <[email protected]>

* complete fixed charge routine

Signed-off-by: Jonathan Schöps <[email protected]>

* Removed an unnessesary import

Signed-off-by: Jonathan Schöps <[email protected]>

* more convenient function name

Signed-off-by: Jonathan Schöps <[email protected]>

* Worked in the suggested changes

Signed-off-by: Jonathan Schöps <[email protected]>

* Added a changelog entry

Signed-off-by: Jonathan Schöps <[email protected]>

* Changes a bug with an array type

Signed-off-by: Jonathan Schöps <[email protected]>

* removed left over print statements

Signed-off-by: Jonathan Schöps <[email protected]>

* Implemented requested changes

Signed-off-by: Jonathan Schöps <[email protected]>

* Added a new test to raise a ValueError

Signed-off-by: Jonathan Schöps <[email protected]>

---------

Signed-off-by: Jonathan Schöps <[email protected]>

* `atlist` to `ati` and back conversion (#81)

* implement atlist to ati conversion

Signed-off-by: Marcel Müller <[email protected]>

* add conversion test

Signed-off-by: Marcel Müller <[email protected]>

---------

Signed-off-by: Marcel Müller <[email protected]>

* Bug fix were uhf was always 0 if a fixed charge were given (#80)

* bug fix were uhf was always 0 if a fixed charge were given

Signed-off-by: Jonathan Schöps <[email protected]>

* updated a test for the right uhf

Signed-off-by: Jonathan Schöps <[email protected]>

* get rid of redundant code within set_random_charge

Signed-off-by: Jonathan Schöps <[email protected]>

* using atlist as a variable in misscellaneous

Signed-off-by: Jonathan Schöps <[email protected]>

---------

Signed-off-by: Jonathan Schöps <[email protected]>

* adapt CODEOWNERS to commit history (#82)

Signed-off-by: Marcel Müller <[email protected]>

* The `.UHF` file is now written if the molecule has a uhf larger than 0 (#74)

* The .UHF file is now written if the molecule has a uhf larger than 0

Signed-off-by: Jonathan Schöps <[email protected]>

* Writes the .CHRG file if the charge is larger than 0

Signed-off-by: Jonathan Schöps <[email protected]>

* charge and uhf can be None

Signed-off-by: Jonathan Schöps <[email protected]>

* Negative charge is now written aswell

Signed-off-by: Jonathan Schöps <[email protected]>

---------

Signed-off-by: Jonathan Schöps <[email protected]>

* update CHANGELOG

Signed-off-by: Marcel Müller <[email protected]>

---------

Signed-off-by: Marcel Müller <[email protected]>
Signed-off-by: Jonathan Schöps <[email protected]>
Co-authored-by: Jonathan Schöps <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix wrong license information in pyproject.toml
2 participants