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

Add AlchemiscaleClient method for producing archival-quality extracts of AlchemicalNetworks and their existing results #246

Open
dotsdl opened this issue Feb 23, 2024 · 1 comment

Comments

@dotsdl
Copy link
Member

dotsdl commented Feb 23, 2024

Since alchemiscale is an execution system for AlchemicalNetworks, not an archival system, we should provide a clear pathway for producing archival-quality extracts of AlchemicalNetworks and their existing results.

There are potentially many ways to accomplish this, but ideally the serialized form of an AlchemicalNetwork and its ProtocolDAGResults has the following properties:

  1. Can be easily consumed by analysis tools, such as cinnabar.
  2. Can be used as a starting point for tools used to define AlchemicalNetworks, so round-trippable into GufeTokenizables with at least the same library versions as those used to create them.
  3. Possible to usefully parse without any OpenFE tooling at all, even if not recommended.
  4. Suitable for archival and sharing on citable FAIR data repositories, such as Zenodo.

Some of the solution to this issue may make sense for inclusion in gufe, as this need is not necessarily specific to alchemiscale.

@dotsdl
Copy link
Member Author

dotsdl commented May 28, 2024

Proposed API point:

    def get_archival_extract(
            network: ScopedKey,
            metadata: Dict[str, Any],
    ) -> AlchemicalArchive:
        """
        Tuple[AlchemicalNetwork, Dict[str, List[ProtocolDAGResult]], Dict[str, Any]]
        """

        ...

where an AlchemicalArchive is a new data structure defined at the gufe level, including an AlchemicalNetwork, results, and metadata.

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

No branches or pull requests

1 participant