Giter Site home page Giter Site logo

swhappe's Introduction


SWHAP@PISA


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 a template repository 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 an overview, see the presentation at HaPoC 2019.

For a detailed guide on how to use SWHAPPE, please refer to the walk through an example in section 4 of the same guide and to the scripted acquisition example.

Current state

The list of the currently available acquisitions is in the Catalogue.

Notable acquisitions include: CMM, OrbFit, TAUmus, Softi.

The list of people who participated to the SHWAPPE definition can be found in actors.md, while a log of the process evolution con be found in journal.md.

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.


🚧 👷 Warning this repository is still under contruction 👷 🚧

swhappe's People

Contributors

carloqmontangero avatar laurab1 avatar rdicosmo avatar scatenag avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

Forkers

patlachance

swhappe's Issues

Rename repository : from DIUNIPI4SWH to DIUNIPIxSWH

@Unipisa/software-heritage
As more people are involved in this process, I am planning to :

  1. make the repository public (at least a visible by everyone.. leaving the "work in progress" disclaimer for a while)
  2. rename the repository as DIUNIPIxSWH (do you have some other nice suggestions ?)

Of course, 2. require to update all the links in the produced material: for this reason, sooner is better.

Ristrutturazione Repository per apertura al pubblico

In vista di una prossima apertura al pubblico del repository è necessario :

  • un cappelletto con logo ( @laurab1 ) e descrizione incisiva con riefrimenti a contatti/amministratori ( @CarloQMontangero )
  • Estrarre da working notepad la descrizione del processo e metterla in coda nel readme o in un ABOUT.md linkato dal readme
  • linkare e scrivere HOWTO.md
  • fare una pulizia del repositori da note e appunti e metterli in un repository privato

[PROCESS] How to accept/trace contributions from outside UNIPISA ?

In the case of someone outside Unipisa wants to contribute/acquire software :

  • should we invite them into Unipisa as an external collaborator?
  • should he follow the process individually ? should he notify us, in order to keep a catalogue of software acquired by SHWAP (or topics tags are enough)?

[Stories] Collecting inventory of metadata, images, dates for CMM

This issue is a placeholder to collect and identify the inventory for a SWH-Story.
@emulatingkat has agreed to add the metadata into Wikidata and create links with the items on the web.
We need someone from the Pisa team to upload the content (images, slides, videos, etc.) to Wikimedia commons.

Depository: https://github.com/Unipisa/CMM-Depository

Software Story: a visual representation in a linear story-line of the software in its context
a moment: a page in the story-line, i.e:

  • timeline
  • image
  • video
  • people
  • wikimedia gallery
  • map
  • publications (bookshelf)
  • wikidata properties
  • wikipedia page

[Stories] Collecting inventory of metadata, images, dates for Softi

This issue is a placeholder to collect and identify the inventory for a SWH-Story.
@emulatingkat has agreed to add the metadata into Wikidata and create links with the items on the web.
We need someone from the Pisa team to upload the content (images, slides, videos, etc.) to Wikimedia commons.

Software Story: a visual representation in a linear story-line of the software in its context
a moment: a page in the story-line, i.e:

timeline
image
video
people
wikimedia gallery
map
publications (bookshelf)
wikidata properties
wikipedia page

[Stories] Collect links to materials for TAUmus example

A first example to launch the discussion on what items should be presented in a Software Story.

Software Story: a visual representation in a linear story-line of the software in its context
a moment: a page in the story-line, i.e:

  • timeline
  • image
  • video
  • people
  • wikimedia gallery
  • map
  • publications (bookshelf)
  • wikidata properties
  • wikipedia page

A few links:

  1. Pietro Grossi (Q3388139) https://www.wikidata.org/wiki/Q3388139
  2. Igor Stravinsky - Pietro Grossi

Let's collect links and ideas into this issue for the TAUmus example.

FYI, I noticed that TAUmus is not documented in Wikipedia or Wikidata.

[CODEMETA] Questions on the list of codemeta tags that we prepared with Roberto

Hi,
in the list of codemeta tags that swe prepared with Roberto, we found this two fields:

Identifiants externes de type SHA1 SWH, DOI, etc... ; [identifier] ;
...
Depot de code; [codeRepository] ;

codeRepository should be an URL to related resources. Carlo and I wonder whether this URL identifies the site that contains the code identified by the first tag or not necessarily.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.