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

Replace "data space" in docstrings with new definitions #809

Open
cbkerr opened this issue Aug 15, 2022 · 3 comments
Open

Replace "data space" in docstrings with new definitions #809

cbkerr opened this issue Aug 15, 2022 · 3 comments
Labels
documentation Writing or editing documentation

Comments

@cbkerr
Copy link
Member

cbkerr commented Aug 15, 2022

Description

It's an ill-defined term.

What are the differences in semantics between "project workspace" and "project data space"? Or are they synonyms?

@joaander I've found 2 definitions of "data space" in the docs:

Synonymous: all files stored in the jobs in the workspace of the project - (source: Project.create_linked_view)

Not synonymous: the abstract set of all initalized state points (source: Concepts Page) This is in the process of being fixed in glotzerlab/signac-docs#120.
The following link implies that the data space can be changed by changing the value of a state point: https://docs.signac.io/en/latest/examples/notebooks/signac_104_Modifying_the_Data_Space.html This contrasts with the first definition because changing the state point (and therefore the job id) does not remove the files stored in that job directory, and therefore wouldn't change a linked view (like what you get from the signac view command)
#743 (comment)

How to fix

Replace with "workspace" if it means the files in the workspace of a project.

Replace with ???? if it refers to the abstract idea of all data that could go in a project.

For context, see:

@cbkerr cbkerr added the documentation Writing or editing documentation label Aug 15, 2022
@vyasr
Copy link
Contributor

vyasr commented Nov 2, 2022

@cbkerr have you given this issue any further thought?

@stale
Copy link

stale bot commented Jan 7, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Jan 7, 2023
@cbkerr
Copy link
Member Author

cbkerr commented Mar 29, 2023

Definition of data space in project.rst: "the underlying data generated and manipulated by these operations."

"A signac project is a conceptual entity consisting of three components:

(1) a data space,
(2) scripts and routines that operate on that space, and
(3) the project’s documentation.

This division corresponds largely to the definition of a computational project outlined by Wilson et al. The primary function of signac is to provide a single interface between component (2), the scripts encapsulating the project logic, and component (1), the underlying data generated and manipulated by these operations."

I found an implied definition in jobs.rst

In general an instance of :py:class:Job only gives you a handle to a Python object. To create the underlying workspace directory and thus make the job part of the data space, you must initialize it."

@stale stale bot removed the stale label Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Writing or editing documentation
Projects
None yet
Development

No branches or pull requests

2 participants