Giter Club home page Giter Club logo

osodos's Introduction

OSODOS: Open Science, Open Data, Open Source

About this project

This repository contains reading/teaching materials that touch on the following topics:

  • Open Access scholarly publishing
  • Open Source software development
  • Open Data integration and sharing

These materials are intended to be freely disseminated as an e-book and/or a website, which can be accessed at:

Directory layout

  • data - contains any structured data files that are needed for publishing the materials. This includes machine readable bibliographic data, and possibly other types of data, such as tables or lists.
  • docs - contains i) the prose itself, in markdown format ii) any embedded images, iii) the prose as generated HTML.
  • node_modules - contains Node.js dependencies. As this is 3rd party code that we haven't touched this should probably be removed.
  • src - contains any scripts needed for publishing the materials. This includes scripts for processing the bibliography.
  • book.json - a configuration file in JSON format for the gitbook generator.
  • _config.json - a configuration file for the gh-pages website. This is possibly an orphaned file to be deleted (as we use the gitbook as a website).

How to build/publish

  1. Check to see if the Mendeley library has newer records than the markdown bibliography. If yes, export the Mendeley library to BibTeX (using the Mendeley Desktop program) and commit it to the repository, overwriting the current bibtex export.
  2. Run the conversion script, i.e.: python src/bib2markdown.py data/references.bib > docs/REFERENCES/README.md
  3. Run the gitbook builder, i.e. gitbook build . docs/gitbook
  4. Commit and push, e.g. git commit -m 're-generated' --all && git push. It takes a minute for the updated site to be 'live'.

Disclaimers, terms and conditions

This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/ or send a letter to Creative Commons, PO Box 1866, Mountain View, CA 94042, USA.

osodos's People

Contributors

pfern avatar rvosa avatar yarikoptic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

osodos's Issues

Re-generate HTML

The static html for the gitbook website needs to be re-generated to fold in the latest changes (notably, the roadmap).

Analytics

...do we get them via github pages? Or do we need to insert a google analytics widget?

SciHub

SciHub may not survive the current war with well funded publishers.
But, in the scope of the 2017 panorama it plays an important role in transforming the methods of access.
Can we converge on a way to refer to it?

Domain name, project structure

  • exclude node.js dependencies from the git repo
  • export the gitbook to an external repo (should be osodos.github.io)
  • make it so that the domain name "sticks" instead of forwards
  • remove the _config.yml files

Content goals

Add "Expected outcomes" section to pages:

  • Publishing,
  • Data capture,
  • Reproducibility,
  • Data sharing,
  • Data management

In addition:

  • add exercises and/or activities section to all pages
  • write out the roadmap for stakeholders, including professional societies

Who is this for?

Graduate students
Lab technicians
Data scientists
Principal investigators
Publishers

Maybe we can add funding agents to this list.

Quizzes

The gitbook "quizzes" plugin needs to be tested / used for exercises.

Choose cover image

  • add cover art bitmaps to the repo
  • combine them with institutional logos (maybe link to separate files in the same document?)
  • lay out rest of the cover page

Manage references

At various points in the prose we cite scientific publications. To keep this manageable among collaborators we adopted the following workflow:

  1. We collected references using the Mendeley browser bookmarklet, which resulted in a public library. We then made sure in Mendeley Desktop that every reference has an author, year, title, journal, and doi. We also made sure that all authors only had initials in their first names.
  2. We then exported the Mendeley library to a bibtex file
  3. We ran a script that converts the bibtex file to a list of references in Markdown
  4. We cited the references by their bibtex key, e.g. [Zhang2014](../REFERENCES#Zhang2014)

Make glossary

We want an index that links terms to the pages they occur on. From among those terms we pick the ones we want to give a definition, and this becomes the glossary.

Containerisation is imho a bit misrepresented

While working out #27 and reading the opening of that paragraph

**containerisation** - a more lightweight solution for bundling tools that are
otherwise difficult to install is offered by "containerisation"

Although it is true, it is just a single use case, and may be not even that common or prominent reason in at least scientific computing. I have some experience (a Debian developer) with managing software dependencies, and overall systems administration etc., so I have no difficulty to install tools (as many others who use some good Linux distribution which comes with many packages available already). I do love containers for a variety of other reasons though

  • experimentation -- so easy and fast to get into another (Linux) environment I would otherwise spend hours installing/configuring if it was a fully fledged virtual machine
  • reproducible computing -- even having captured full provenance (in a provisioning script or alike), deploying it for real use is too tedious and fragile (services could go down, versions disappear etc). Having a container image - I can always get that environment (e.g. if I keep it also under version control system. if not -- success might vary ;-)).
  • portable computing -- I can transfer container image to another HPC or into the cloud and perform necessary computing without demanding (re)configuring that environment for my needs
  • collaboration -- we do use the same "computing" pieces while using different base OS

Virtualization is unnecessarily too heavy for any of those use cases, and thus in my world its use is greatly diminished.

So I think that this paragraph should be reword a little to reflect advantages of containers better.

E-book versions

It would be good to have somewhat better releases for the next version. E.g.:

  • make a PDF version and tag that as "the" release DOI
  • attach other e-book versions and the source tree as dependent DOIs (you can do this in zenodo)

This way the DOI actually links to something useful for readers rather than the zipped repository, and we are in control of the PDF and e-book versions (rather than have these be dispersed by 3rd parties), so we can track downloads and such.

Course planning

What do we want to do:

  • describe learning objectives
  • describe target learner and pre-requisites
  • identify learning outcomes and scope (#2)
  • decompose into subsections, e.g. re-runnability, data provenance, etc. (#2)
  • develop exercises, at least one for each learning outcome, but actually very many
  • collect readings https://www.mendeley.com/community/osodos/ (#10)
  • prepare lectures
  • plan documentation

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.