IMP.pmi.metadata.Repository Class Reference

A repository containing modeling files. More...

Inheritance diagram for IMP.pmi.metadata.Repository:

Detailed Description

A repository containing modeling files.

This can be used if the PMI script plus input files are part of a repository, which has been archived somewhere with a DOI. This will be used to construct permanent references to files used in this modeling, even if they haven't been uploaded to a database such as PDB or EMDB.

See Also

FileLocation.

Note

This class is only available in Python.

Definition at line 187 of file metadata.py.

Public Member Functions
def	__init__
	Constructor. More...
def	update_in_repos
	If the given FileLocation maps to somewhere within one of the passed repositories, update it to reflect that. More...

Constructor & Destructor Documentation

def IMP.pmi.metadata.Repository.__init__	(		self,
			doi,
			root = None,
			url = None,
			top_directory = None
	)

Constructor.

Parameters

doi	the Digital Object Identifier for the repository.
root	the relative path to the top-level directory of the repository from the working directory of the script, or None if files in this repository aren't checked out.
url	If given, a location that this repository can be downloaded from.
top_directory	If given, prefix all paths for files in this repository with this value. This is useful when the archived version of the repository is found in a subdirectory at the URL or DOI (for example, GitHub repositories archived at Zenodo get placed in a subdirectory named for the repository and git hash).

Definition at line 203 of file metadata.py.

Member Function Documentation

def IMP.pmi.metadata.Repository.update_in_repos	(		fileloc,
			repos
	)

If the given FileLocation maps to somewhere within one of the passed repositories, update it to reflect that.

Definition at line 226 of file metadata.py.

---

The documentation for this class was generated from the following file:

• metadata.py