free-cortex / framework

:octocat: A free continuous integration framework for open scientific communication based-on LaTeX
0 stars 0 forks source link

free-corTeX

A free continuous integration framework for open scientific communication based-on LaTeX

Nearly a decade ago, December 2011, Roger Peng published an spectrum of reproducibility which depicts a roadmap of a scientific outcome that went from publication only to full replication (e.g., including code, data and software). Such spectrum was a cornerstone for the publication of the first open-accessible and 100\% reproducible engineering-based PhD thesis in August 2019 at the University of Birmingham established in 1900. Even thought of such achievement, there are few challenges in the existing system of formal scientific communication. Such challenges were recently described by Heise and Pearce 2020 for aspects of evaluation of scientific work, speed in the communication process, respect for the freedom of science and research, dissemination and accessibility, digitization, verifiability of scientific knowledge, quality, and prevention of misuse and scientific misconduct. Alongside with the state-of-the-art of research software engineering in the context of open access science that is starting to make use of continuous integration tools (Luger and Foreman-Mackey 2019) and containers (Xu 2020). That being said, this work introduce a proof-of-concept "free-corTeX: A free continuous integration framework for open scientific communication based-on LaTeX" as an updated version of the spectrum of reproducibility for formal scientific communication. Using free-corTeX, one can create various academic documents such as thesis, cv, slides, and reports. The adoption of free-corTeX might lead to scientific outcomes that are well aligned to the principles of reproducibility, inclusiveness, transparency, reusability and open accessibility.

Open scientific documents

Poster :link:

GitHub Actions Status poster

IEEE Article :link:

GitHub Actions Status ieee-poster

Thesis :link:

GitHub Actions Status ieee-poster

Slides :link:

GitHub Actions Status ieee-poster

CV :link:

GitHub Actions Status ieee-poster

Usage

See workflow for further details on the usage of the framework.

Clone repository

After generating your SSH keys as suggested here, you can then clone the repository by typing (or copying) the following line in a terminal at your selected path in your machine:

git clone git@github.com:free-cortex/framework.git

Licence and Citation

The work in this repository is under Creative Commons Attribution-Share Alike license License: CC BY-SA 4.0. Hence, you are free to reuse it and modify it as much as you want and as long as you cite this work as original reference and you re-share your work under the same terms.

Cite as

Xochicale, Miguel (2020): open-corTeX: A continuous integration framework for open scientific communication. figshare. Poster. https://doi.org/10.6084/m9.figshare.12927701.v1

BibTeX to cite

@article{Xochicale2020,
author = "Miguel Xochicale",
title = "{open-corTeX: A continuous integration framework for open scientific communication}",
year = "2020",
month = "9",
url = "https://figshare.com/articles/poster/open-corTeX_A_continuous_integration_framework_for_open_scientific_communication/12927701",
doi = "10.6084/m9.figshare.12927701.v1"
}

Contact

If you have specific questions about the content of this repository, you can contact Miguel Xochicale. If your question might be relevant to other people, please instead open an issue.