SWHAP@Pisa
The SWHAP@Pisa project is a joint venture of the Department of Computer Science of the University of Pisa and Software Heritage (SWH). It aims at defining and supporting a process to acquire sorce code to be saved in the SWH archive.
This repository brings together the documentation, the catalogue and other information about this process, dubbed SWH Acquisition Process (SWHAP) and its Github based support SWHAPPE (SWHAP Pisa Enactor).
The Process
SWHAP organizes the activities involved in the acquisition process in four phases:
- collect, aiming at finding the source code and related materials and gathering each piece as is in physical or logical places where they can be properly archived for later processing;
- curate, aiming at analyzing, cleaning up and structuring the raw materials that have been collected;
- archive, aiming at contributing the curated materials to specialized public archives, Software Heritage in primis;
- present, aiming at creating dedicated presentations of the curated materials.
The process must be seen as iterative, in the sense that, when new materials are available, the pertinent phase can be re-entered and the process enacted once more from there to update all the relevant information.
For more details, please see the process documentation.
Process support
The SWHAP@Pisa project designed and implemented the SWHAP Pisa Enactor (SWHAPPE), an environment to support SWHAP based on the platform you are accessing, that is, GitHub.
SWHAPPE provides template repositories to be instantiated and then filled for each acquisition. According to the supported naming rules, acquiring the source code XYZ will result in the following repositories:
- the XYZ Workbench, a working area where one can temporarily collect the materials and then proceed to curate the code;
- the XYZ Depository, to archive the raw materials;
- the XYZ, where the version history of the code is rebuilt by the curation team, as it is archived in SWH.
For a detailed description of SWHAPPE, please see section 3 of the SWHAP guide.
For a detailed guide on how to use SWHAPPE, please refer to the walk through an example in section 4 of the same guide.
Current state
The list of the currently available acquisitions is in the Catalogue.
Notable acquisitions include: CMM, OrbFit, TAUmus, Softi.
How To Contribute
This is a mailing list dedicated to the Software Heritage Acquisition Process. Feel free to register and exchange informations and best practices.
For more details see the process documentation.
🚧 👷 Warning this repository is still under contruction 👷 🚧