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

Define a generic directory type #922

Open
vyasr opened this issue May 6, 2023 · 0 comments
Open

Define a generic directory type #922

vyasr opened this issue May 6, 2023 · 0 comments
Labels
pinned Instructs stale bot to ignore this issue.

Comments

@vyasr
Copy link
Contributor

vyasr commented May 6, 2023

Feature description

The Job and Project classes are both handles on different types of directories. signac's data model encodes a specific data layout that implies a relationship between the two, but there are also various pieces of common functionality that could be isolated into a common class. Moreover, any attempt to generalize the data layouts signac supports would require some concept of operating on an arbitrary directory within some directory tree structure.

Proposed solution

We should implement a common signac.Directory base class that handles the basic common functionality of a single directory. The initial starting point would simply be extracting common functions out of the Job and Project. Further inspiration may be found in the signac-2 prototype. If #96 is implemented, a directory could also be identified by a single identifier.

@vyasr vyasr added the pinned Instructs stale bot to ignore this issue. label May 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pinned Instructs stale bot to ignore this issue.
Projects
None yet
Development

No branches or pull requests

1 participant