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 #229

Merged
merged 4 commits into from
Jan 25, 2023
Merged

update docs #229

merged 4 commits into from
Jan 25, 2023

Conversation

shoubhikraj
Copy link
Collaborator

@shoubhikraj shoubhikraj commented Jan 16, 2023

Update docs for windows install and for temporary_config() context manager.

Related to #227

@codecov
Copy link

codecov bot commented Jan 16, 2023

Codecov Report

❗ No coverage uploaded for pull request base (v1.4.0@23af779). Click here to learn what that means.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             v1.4.0     #229   +/-   ##
=========================================
  Coverage          ?   97.22%           
=========================================
  Files             ?      195           
  Lines             ?    20323           
  Branches          ?        0           
=========================================
  Hits              ?    19760           
  Misses            ?      563           
  Partials          ?        0           
Flag Coverage Δ
unittests 97.22% <0.00%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@shoubhikraj
Copy link
Collaborator Author

@t-young31 Could you please set the CI tests to rerun? I think something went wrong on this run as the error is in the install stage (and no install files were modified)

@shoubhikraj shoubhikraj added the documentation Improvements or additions to documentation label Jan 23, 2023
the context manager will become useless after it exits. Please see the example
below for details.

.. code-block:: python
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this render ok (with a code-block inside a warning)?

Copy link
Collaborator Author

@shoubhikraj shoubhikraj Jan 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@t-young31 No, the code-block is outside the warning. (At least that's how it is rendered now in Pycharm) Would it be better to put it inside the warning box?

doc/config.rst Outdated Show resolved Hide resolved
Copy link
Member

@t-young31 t-young31 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great – thank you. Left a couple of tiny comments 😄

@t-young31
Copy link
Member

looks like the pyqt Windows conda binary is mangled somehow 😞
https://github.com/duartegroup/autodE/actions/runs/3933707055/jobs/6842810681#step:4:2449

Co-authored-by: Tom Young <39765193+t-young31@users.noreply.github.com>
@shoubhikraj
Copy link
Collaborator Author

shoubhikraj commented Jan 23, 2023

looks like the pyqt Windows conda binary is mangled somehow 😞 https://github.com/duartegroup/autodE/actions/runs/3933707055/jobs/6842810681#step:4:2449

Hmm, that's odd because the tests passed successfully on my other PR for the windows compatibility, and that was just a few days ago. I don't think there is any solution to this as it's a conda issue, but if it persists then future PR's after 1.4.0 would be affected 😕 . Happy for you to merge the PR.

@t-young31 t-young31 merged commit 88bbe78 into duartegroup:v1.4.0 Jan 25, 2023
t-young31 added a commit that referenced this pull request Feb 20, 2023
* update docs for windows installation and temporary_config

* update docs for windows installation and temporary_config

* minor edit

Co-authored-by: Tom Young <39765193+t-young31@users.noreply.github.com>
shoubhikraj added a commit to shoubhikraj/autodE that referenced this pull request Feb 21, 2023
* Ignore doc paths for code CI (duartegroup#235)

* Ignore doc paths for code CI

* Update PR template

* Add "ERROR" level to logging (duartegroup#231)

* add ERROR level to logging

* update docs for logging

* update tests for logging

* update changelog

* Fix parsing Qchem v6 output (duartegroup#234)

* Fix parsing Qchem v6 output

* Fix units for values div mul (duartegroup#242)

* Fix units for div mul

* Update changelog

* Update workflow (duartegroup#244)

* Fix xtb opt with cartesian coordinates (duartegroup#247)

* Fix xtb opt with cartesian coordinates

* Update changelog [skip actions]

* Remove hessian conversion on normal mode calculation (duartegroup#243)

* Ensure no unit conversion in hessian

* Use a copy for value and valuearray

* Raise exception on value `to` with inplace

* Add missed changelog updates

* Template for v1.4.0 (duartegroup#203)

* Make autodE compatible with Windows and change parallel process handling (duartegroup#202)

* make autode compatible with windows: replace multiprocessing with joblib and loky

* remove comment autode/utils.py

* check total memory in utils

* use loky for parallel processing

* loky context is used for better handling of parallelisation

* fixes for timeout wrapper in POSIX

* use class instances instead of class attributes for Config

* pass parent Config state into child processes

* keep default timeout wrapper, also add new wrapper

* separate parallelisation scheme for windows, restore default for linux/mac

* fix test_config_in_worker_proc for posix

* codecov on windows

* add tests for config copy

* change config implementation for updating in worker process

* add context manager for temporary config, minor fix in experimental timeout for windows

* add tests for context manager

* use bash for installing xtb in CI runner

* add tests for cleanup after timeout

* exclude setup.py from codecov

* make config picklable and easily readable

* add test and minor fixes

* move xtb install script to .github/scripts

* use temporary_config for test_utils.py

* update changelog and contributor list

* resolve conflicts with v1.4.0

Co-authored-by: Tom Young <39765193+t-young31@users.noreply.github.com>

* update docs (duartegroup#229)

* update docs for windows installation and temporary_config

* update docs for windows installation and temporary_config

* minor edit

Co-authored-by: Tom Young <39765193+t-young31@users.noreply.github.com>

* Autouse tempoary_config (duartegroup#236)

* minor fixes

---------

Co-authored-by: Tom Young <39765193+t-young31@users.noreply.github.com>
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.

2 participants