Miten julkaisen koodia?

Tutkimuksen tekoon liittyvää koodia voi ja kannattaa julkaista samaan tapaan kuin tutkimusaineistoja. Tältä sivulta löydät ohjeet, miten toimia tilanteessa, jossa haluat julkaista koodia Jyväskylän yliopiston tutkimustietojärjestelmien kautta.

Koodin julkaisemisessa toimitaan samoin kuin julkaistaessa muuta tutkimusaineistoa: 

  1. Ensin tutkija laatii koodista metatiedot yliopiston Converiksen aineisto-osioon (ks. "Tutkimusaineistojen kuvailu Converikseen" -ohje sivun alaosassa).
  2. Koodille valitaan sopiva käyttölisenssi (ks. "Miten valitsen sopivan lisenssin?" -ohje sivun alaosassa).
  3. Tutkija paketoi julkaistavan koodin .zip-pakettiin ja toimittaa sen julkaistavaksi joko Converis-tietojen yhteydessä täytettävän Nextcloudin jakolinkin kautta tai ²õä³ó°ìö±è´Ç²õ³Ù¾±³Ù²õ±ð.

Koodia julkaistessa tulee harkita kahta eri vaihtoehtoa tai tarvittaessa molempia: 

  1. koodirepositorion (esim. GitLab) yleisten kuvailu- eli metatiedot julkaisemista tai,
  2. julkaisemalla kaappauksen (ns. snapshot, tilannekuva) koodista tietyllä ajanhetkellä julkaisua.


Koodin kaappauksen julkaiseminen JYX:issä

Koodin nykyversiolle voi saada DOI:n JYX-julkaisemisen yhteydessä niin, että koodin nykyisestä versiosta ladataan kopio (tilannekuva, snapshot), joka julkaistaan JYXissä koodin kuvailutietojen ohessa. Kun olet ladannut GitLabista kopion projektin nykytilanteesta, toimi tämän sivun alaosaan linkitetyn "Tutkimusaineiston julkaiseminen JYXissä" -ohjeen mukaan.

Mikäli odotettavissa on tarve useille koodin versioille, on mahdollista julkaista koko repositorion metatiedot ns. emoaineistona ja julkaista yksittäisiä tilannekuvia koodista sen ala-aineistoina.

Mikäli odotettavissa on tarve useille koodin versioille, on mahdollista julkaista koko repon metatiedot ns. emoaineistona ja julkaista yksittäisiä tilannekuvia koodista sen ala-aineistoina.
 

Koodin julkaiseminen Zenodossa

GitHubissa olevaa koodia on mahdollista julkaista myös Zenodossa GitHubin automaattisen Zenodo-yhteyden kautta. Zenodossa koodin tilannekuva saa FAIR-periaatteiden mukaisesti pysyvän tunnisteen (DOI). Ohjeet löydät täältä.

Tälle sivulle päivitetään elokuun 2024 aikana esimerkki ja kuvaohje koodin julkaisemisesta JYUn GitLab-repositoriosta. 

Tarvitsetko apua koodin julkaisemiseen? Ota yhteyttä Tutkimusaineistopalveluihin