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

Move internal signac files into .signac subdirectory #708

Merged
merged 3 commits into from
Mar 6, 2022

Conversation

vyasr
Copy link
Contributor

@vyasr vyasr commented Mar 4, 2022

Description

This PR moves the shell history and state point cache files into the .signac directory.

Motivation and Context

Resolves #197. I have intentionally chosen to do nothing with signac_statepoints.json since that file would only have been created by users actually calling the write_statepoints function and therefore I think we should leave it to users to delete that file if it is present.

Types of Changes

  • Documentation update
  • Bug fix
  • New feature
  • Breaking change1

1The change breaks (or has the potential to break) existing functionality.

Checklist:

If necessary:

  • I have updated the API documentation as part of the package doc-strings.
  • I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
  • I have updated the changelog and added all related issue and pull request numbers for future reference (if applicable). See example below.

@vyasr vyasr added this to the v2.0.0 milestone Mar 4, 2022
@vyasr vyasr requested review from a team as code owners March 4, 2022 22:13
@vyasr vyasr self-assigned this Mar 4, 2022
@vyasr vyasr requested review from atravitz and syjlee and removed request for a team March 4, 2022 22:13
@codecov
Copy link

codecov bot commented Mar 4, 2022

Codecov Report

Merging #708 (62d8920) into schema2 (01873a1) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Impacted file tree graph

@@             Coverage Diff             @@
##           schema2     #708      +/-   ##
===========================================
+ Coverage    86.24%   86.25%   +0.01%     
===========================================
  Files           52       52              
  Lines         5037     5041       +4     
  Branches      1099     1100       +1     
===========================================
+ Hits          4344     4348       +4     
  Misses         491      491              
  Partials       202      202              
Impacted Files Coverage Δ
signac/__main__.py 78.19% <100.00%> (+0.03%) ⬆️
signac/contrib/migration/v1_to_v2.py 92.85% <100.00%> (+0.85%) ⬆️
signac/contrib/project.py 89.29% <100.00%> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 01873a1...62d8920. Read the comment docs.

signac/__main__.py Show resolved Hide resolved
signac/contrib/migration/v1_to_v2.py Outdated Show resolved Hide resolved
signac/contrib/project.py Outdated Show resolved Hide resolved
tests/test_project.py Outdated Show resolved Hide resolved
tests/test_project.py Outdated Show resolved Hide resolved
signac/contrib/migration/v1_to_v2.py Outdated Show resolved Hide resolved
tests/test_project.py Show resolved Hide resolved
@vyasr vyasr requested a review from bdice March 5, 2022 01:43
@vyasr vyasr merged commit ed60092 into schema2 Mar 6, 2022
@vyasr vyasr deleted the schema/move_files branch March 6, 2022 01:30
vyasr added a commit that referenced this pull request Mar 14, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
vyasr added a commit that referenced this pull request Apr 14, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
vyasr added a commit that referenced this pull request Apr 19, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
vyasr added a commit that referenced this pull request Apr 19, 2022
* Initial migration to schema version 2 including config rename (#678)

* Implement initial migration to schema version 2.

* Require project-local config to be signac.rc (not .signacrc) and make searches stricter to match.

* Standardize method for getting project config at a root.

* Move config to .signac/config.

* Fix import order.

* Address PR comments.

* Remove some unnecessary code.

* Address final PR coments.

* Use integer schema version numbers (#688)

* Change schema versioning to use integer strings.

* Switch from int strings to pure ints.

* Update signac/contrib/migration/__init__.py

Co-authored-by: Bradley Dice <[email protected]>

Co-authored-by: Bradley Dice <[email protected]>

* Remove project name from schema (#684)

* Remove project id API.

* Remove project name from config as part of migration.

* Fix issues with config CLI and remove project from default cfg.

* Address PR comments.

* Change the str of a project to the str of its root directory.

* Change Project constructor to use root directory (#706)

* Change project constructor to accept a root directory instead of a config file.

* Change Project repr.

* Address easy PR comments.

* Move internal signac files into .signac subdirectory (#708)

* Move shell history.

* Move sp_cache file.

* Address PR comments.

* Move discovery to separate functions. (#711)

* Move discovery to separate functions.

* Address first round of PR comments.

* Address PR comments.

* Apply suggestions.

* Remove configurable workspace directory  (#714)

* Remove workspace configurability.

* Implement workspace_dir migration.

* Apply suggestions from code review

Co-authored-by: Bradley Dice <[email protected]>

* Address remaining PR comments.

* Update tests/test_project.py

* Remove mention of configurability from project workspace docstring

* Address PR comments.

Co-authored-by: Bradley Dice <[email protected]>
Co-authored-by: Corwin Kerr <[email protected]>

* Update description of schema migration.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: Bradley Dice <[email protected]>
Co-authored-by: Corwin Kerr <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
vyasr added a commit that referenced this pull request Apr 21, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
vyasr added a commit that referenced this pull request May 2, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
bdice pushed a commit that referenced this pull request Jun 14, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
bdice pushed a commit that referenced this pull request Aug 1, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
bdice pushed a commit that referenced this pull request Oct 7, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
bdice pushed a commit that referenced this pull request Oct 27, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
vyasr added a commit that referenced this pull request Oct 30, 2022
* Move shell history.

* Move sp_cache file.

* Address PR comments.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants