DOCK 3.8:How to build a release: Difference between revisions

From DISI
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
This page describes how to take the three github repos, combine them, and create a tarball for public use.  
This page describes the formal definition of a release of the [https://dock.compbio.ucsf.edu/ ''UCSF DOCK''] software suite


1. Build desired version of [[pydock3]] Python package (e.g., build pip-installable wheel file using [[Python Poetry|poetry]]).
1. Build desired version of [[pydock3]] Python package (e.g., build pip-installable wheel file using [[Python Poetry|poetry]]).
2. Clone desired version of [[dock3]] program.
2. Clone desired version of [[dock3]] program.
3. Incorporate fruits of (1) and (2) into [[UCSF_DOCK]] repository housing legacy scripts that remain essential to established protocols (e.g., build scripts, post-processing scripts).
3. Incorporate the fruits of (1) and (2) into [[DOCK3.8]] repository housing an arsenal of scripts (e.g., 3D build scripts, post-processing scripts) that are essential for following the [https://www.nature.com/articles/s41596-021-00597-z published Nature protocol].


A particular commit of the UCSF_DOCK repository becomes a particular distribution of ''UCSF DOCK'' software when the repository is assigned a tag of its [https://semver.org/ semantic version (e.g., v1.2.3)].
A particular commit of the DOCK3.8 repository formally becomes a particular distribution of [https://dock.compbio.ucsf.edu/ ''UCSF DOCK''] software when the commit is tagged with the distribution's [https://semver.org/ semantic version (e.g., DOCK3.8 v1.2.0)]. Note that ''pydock3'' and ''dock3'' are separately versioned from ''DOCK3.8''.




[[Category:DOCK 3.8]]
[[Category:DOCK 3.8]]

Revision as of 08:47, 26 January 2024

This page describes the formal definition of a release of the UCSF DOCK software suite

1. Build desired version of pydock3 Python package (e.g., build pip-installable wheel file using poetry). 2. Clone desired version of dock3 program. 3. Incorporate the fruits of (1) and (2) into DOCK3.8 repository housing an arsenal of scripts (e.g., 3D build scripts, post-processing scripts) that are essential for following the published Nature protocol.

A particular commit of the DOCK3.8 repository formally becomes a particular distribution of UCSF DOCK software when the commit is tagged with the distribution's semantic version (e.g., DOCK3.8 v1.2.0). Note that pydock3 and dock3 are separately versioned from DOCK3.8.

Retrieved from "http://wiki.docking.org/index.php?title=DOCK_3.8:How_to_build_a_release&oldid=15610"