Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added an 'open' section to the site #75

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/open/data.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
id: open-data
title: Open Data
custom_edit_url: null
---

Open data is the concept of making data freely available to everyone, without restrictions on access or reuse. By embracing open data practices, researchers, organizations, and governments can promote transparency, foster collaboration, and drive innovation across various domains.

## Key Principles of Open Data

1. **Accessibility:** Ensuring that data is easily discoverable, accessible, and available in open, non-proprietary formats.
2. **Reusability:** Enabling data to be freely used, reused, and redistributed by anyone, subject only to attribution requirements or share-alike restrictions.
3. **Interoperability:** Providing data in standardized formats and with appropriate metadata to facilitate integration and combination with other datasets.
4. **Transparency:** Making data collection methodologies, data processing techniques, and data quality assessments openly available for scrutiny and validation.
5. **Privacy and Security:** Implementing measures to protect personal privacy, maintain data confidentiality, and ensure data integrity and security.
6. **Sustainability:** Ensuring long-term preservation, curation, and accessibility of open data through appropriate data management practices and infrastructure.

## Key Practices of Open Data

1. **Data Sharing:** Publishing data in open repositories, data journals, or online platforms, accompanied by comprehensive metadata and documentation.
2. **Open Licensing:** Applying open licenses (e.g., Creative Commons, Open Data Commons) to data, enabling reuse, redistribution, and integration with other datasets.
3. **Data Management Planning:** Developing and adhering to data management plans that outline data collection, processing, documentation, and sharing strategies.
4. **Data Curation and Preservation:** Implementing practices for data cleaning, quality assurance, and long-term preservation to ensure data integrity and usability over time.
5. **Data Citation:** Promoting the practice of citing data sources and assigning persistent identifiers (e.g., DOIs) to enable proper attribution and tracking of data usage.
6. **Open Data Advocacy:** Advocating for open data principles and practices within organizations, communities, and policymaking bodies, fostering cultural shifts toward data openness and transparency.
7. **Open Data Literacy:** Providing training and educational resources to enhance understanding and skills related to open data management, analysis, and utilization.

By embracing these principles and practices, researchers, organizations, and governments can unlock the potential of open data, enabling data-driven discoveries, fostering collaboration, and driving innovation across various sectors, ultimately benefiting society as a whole.
117 changes: 117 additions & 0 deletions docs/open/open.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
---
id: open
title: The "Open" Landscape
custom_edit_url: null
---

Open Source with SLU is a champion and resource for all things "open" at Saint Louis University. Open science, open scholarship, open data, and open source software are closely interrelated concepts that collectively aim to promote transparency, accessibility, and collaboration in research, education, and knowledge dissemination. While each concept has its unique focus, they share common goals and principles, and their implementation reinforces one another.

## Open Source Software

Open source software enables collaborative research and sustainable innovation.

Open source software is a set of principles and practices. The most obvious practice is making the human-readable "source" code for software freely available for use, study, modification, and distribution. This fosters transparency, collaboration, and continuous improvement. Open source principles promote transparency by making code openly accessible, aligning with reproducibility goals in research. Open source solutions provide cost-effective, customizable alternatives to proprietary software, promoting vendor independence and long-term sustainability. The collaborative nature of open source communities drives sustained innovation and robust software development through diverse contributions and knowledge sharing.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if saying "open source software is a set of principles and practices" is quite accurate. Maybe "open source software is based on a set of principles and practices"?


Research software, a specific category of open source software, plays a crucial role in enabling open science and open scholarship practices. Research software benefits from open source practices, enabling reproducible research workflows, data analysis tools, and collaborative platforms. The adoption of open source research software facilitates open access, open data, and open educational resource initiatives, fostering an ecosystem of shared knowledge and collaboration across disciplines. By embracing open source software, researchers and scholars can drive innovation, enhance software quality, and contribute to a culture of openness in academia.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all research software is open source, so saying that research software is a specific category of open source software is not quite accurate. Maybe "When research software is aligned with open source principles, it plays a critical role ..."


## Open Science

Open Science promotes transparency and reproducibility in research.

Open science is a movement that advocates for transparency, collaboration, and accessibility in scientific research. By embracing open practices such as open data, open access publishing, open source software, open peer review, and open collaboration, researchers can enhance the quality, reproducibility, and impact of their work. Open science principles and practices are fundamental to enabling Open Scholarship and Open Data.

## Open Scholarship

Open Scholarship fosters openness across academic activities.

Open scholarship extends the principles of openness beyond scientific research to encompass all scholarly activities, including teaching, learning, and public engagement. It embraces open access publishing, open educational resources, open collaboration, open peer review, and open advocacy. Open scholarship promotes the free exchange of knowledge, fosters equity and inclusivity, and enhances the societal impact of academic work.

## Open Data

Open data enables data-driven discoveries and sustainable innovation.

Open data refers to the practice of making data freely available for everyone to access, reuse, and redistribute. By embracing open data principles such as accessibility, reusability, interoperability, and transparency, researchers, organizations, and governments can unlock the potential of data-driven discoveries, foster collaboration, and drive innovation across various sectors.

## An Interconnected Landscape

These four concepts are interconnected and mutually reinforcing:
* **Open Science enables Open Data and Open Source Software:** Open science practices, such as preregistration, reproducible research, and open notebooks, promote the sharing and reuse of research data and software, aligning with open data and open source principles.
* **Open Data and Open Source Software fuel Open Science:** The availability of open data and open source software facilitates new scientific discoveries, enables validation of research findings, and supports the principles of open science, such as transparency and reproducibility.
* **Open Scholarship integrates Open Science, Open Data, and Open Source Software:** Open scholarship embraces open science principles and practices, while also promoting open data sharing, open source software utilization, and their integration across diverse scholarly activities, including teaching, learning, and public engagement.
* **Open Scholarship fosters Open Science, Open Data, and Open Source Software:** By advocating for openness in academia, open scholarship encourages the adoption of open science, open data, and open source software practices, fostering a culture of transparency and collaboration.
* **Open Source Software enables Open Science and Open Scholarship:** The use of open source software tools and platforms facilitates open science practices, such as reproducible research and open collaboration, while also supporting open scholarship activities like open publishing and open educational practices.
* **Open Data and Open Science drive Open Source Software development:** The availability of open data and the need for open, transparent, and reproducible research practices fuel the development and adoption of open source software solutions tailored for scientific and scholarly purposes.
Comment on lines +37 to +43
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is kind of a lot to process. I think the message would be easier to comprehend if this was some kind of diagram, demonstrating interconnected-ness.


By understanding and embracing the interconnected nature of open science, open scholarship, open data, and open source software, researchers, educators, and Saint Louis University can create a more transparent, collaborative, and impactful ecosystem for knowledge creation, dissemination, and application.

## Research Funding Mandates for Open Scholarship and Open Science

In recent years governmental and private funding agencies have implemented various mandates and policies to promote open scholarship, open science, and data sharing practices. These mandates aim to increase transparency, accessibility, and reproducibility in federally funded research, while also maximizing the impact and societal benefits of publicly funded research outputs. Here's a summary of some key federal funding mandates:

### Open Data Mandates

* **NIH Public Access Policy (2008):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A link to this policy would add credibility.

* Requires that all peer-reviewed journal articles resulting from NIH-funded research be made publicly available on PubMed Central no later than 12 months after publication.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit awkward to have a bullet list with one bullet. Would it make sense to move the sub-bullet list on the same line as NIH Public Access Policy (2008)?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like it belongs in the Open Access Mandates, not Open Data Mandates.

* **OSTP Public Access Memo (2013):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A link to this document would be helpful (it would also help to understand what OSTP is).

* Directed federal agencies with annual extramural research and development expenditures over $100 million to develop plans for increasing public access to publications and digital data resulting from federally funded research.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about a bullet list with one bullet.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems like it belongs in the open access mandates, not open data mandates.

* **DOE Public Access Plan (2014):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a link to this document, if possible.

* Requires that accepted peer-reviewed manuscripts resulting from DOE-funded research be made publicly available within 12 months of publication.
* Mandates the development of data management plans and encourages the deposition of data in public repositories.
* **NSF Public Access Plan (2015):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a link to this document, if possible.

* Mandates that either the version of record or the final accepted manuscript of journal articles and juried conference papers resulting from NSF-funded research be made publicly available no later than 12 months after publication.
* Requires data management plans for all new proposals and encourages the deposition of data in public repositories.
* **NSF Data Sharing Policy (2023):**
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a link to this document.

* Establishes requirements for NSF-funded researchers to share data, software, and other digital products of NSF-funded research.
* Mandates the deposition of data and other digital products into designated repositories, unless specific exemptions apply.
* Encourages the use of open repositories, formats, and licenses to maximize accessibility and reuse.

### Open Access Mandates
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reading over the Open Data Mandates and Open Access Mandates, I think they are somewhat tangled together. For example, "NSF Data Sharing Policy (2023)" has elements of open data mandate and open access mandate. The split between the two categories seems arbitrary. I wonder if it should just be one sub-section: Open Data and Open Access Mandates, listing out all of these mandates. Adding links to those policies would be useful.


* **NASA Plan for Increasing Access to the Results of Scientific Research (2014):**
* Requires that all NASA-funded authors deposit final peer-reviewed manuscripts into NASA's institutional repository, PubSpace, to be made publicly accessible within one year of publication.
* Encourages the deposition of research data into publicly accessible repositories and the development of data management plans.
* **Federal Research Public Access Act (FRPAA) (Proposed):**
* This proposed legislation would require federal agencies to develop policies ensuring that unclassified research funded by the agency is made publicly accessible online within 12 months of publication.
* **Plan S (International):**
* An initiative from a coalition of research funders, including some U.S. agencies, that requires all scholarly publications resulting from their funded research to be published in open access journals or platforms by 2025.
* **Bill & Melinda Gates Foundation Open Access Policy:**
* Requires that all peer-reviewed publications resulting from foundation-funded research be made openly accessible and available immediately upon publication.
* Encourages the deposition of data in open repositories and the use of open data standards.
* **Wellcome Trust Open Access Policy:**
* Mandates that all research publications resulting from Wellcome Trust funding be made freely available through approved open access repositories or journals.
* Requires the development of data management and sharing plans for all funded projects.
* **Ford Foundation Open Licensing Policy:**
* Requires that all grant-funded work products, including publications, data, and software, be licensed under an open license (e.g., Creative Commons, Open Data Commons) to facilitate reuse and redistribution.
* **Arnold Ventures Open Science Initiative:**
* Supports efforts to promote open science practices, such as preregistration, open data sharing, and research transparency.
* Funds projects and initiatives that develop tools, resources, and infrastructure to enable open science practices.


### Additional Policies and Initiatives

* **OSTP Desirable Characteristics of Data Repositories (2022):**
* Provides guidance on desirable characteristics for data repositories used to store and provide access to federal data.
* **OSTP Guidance on Improving Rigor and Integrity in Research (2022):**
* Encourages the use of open science practices, such as preregistration, transparency in data and code sharing, and open communication.
* **OSTP Nelson Memorandum on Scientific Integrity (2022):**
* Promotes the open and objective communication of scientific facts and data, emphasizing transparency and public access to federally funded research.
* **NASA Scientific Information Policy (2022):**
* Establishes principles and requirements for the open dissemination of NASA scientific and technical information, including publications, data, and software.
* Mandates that NASA-funded research publications and associated data be made publicly accessible through designated repositories.
* Requires the use of open data formats and open-source software when possible.
* **NASA's Transform to Open Science (TOPS) Initiative:**
* A collaborative effort with the scientific community to develop policies, practices, and tools to support open science at NASA.
* Aims to promote open data, open-source software, open publications, and open collaborative platforms for NASA-funded research.
* **NSF Proposal & Award Policies & Procedures Guide (PAPPG):**
* Includes guidelines and requirements for data management plans, open access publishing, and sharing of other research products.
* Encourages the use of open-source software and open data standards to promote transparency and reproducibility.
* **NSF Software Sustainability Plans:**
* Encourages the development of software sustainability plans for research projects involving significant software development efforts.
* Promotes the adoption of open source practices, including version control, automated testing, and documentation.
* **Alfred P. Sloan Foundation Initiatives:**
* Supporting open source software projects and infrastructure for scientific research and academic applications.
* Funding initiatives for open access publishing platforms and open access in specific fields.
* Promoting open data sharing, reproducible research, and computational approaches through data repositories and tool development.
* Advocating for open science practices and fostering collaboration among stakeholders from academia, industry, and government.

These mandates and policies reflect a growing commitment from federal funding agencies to foster open scholarship, open science, and data sharing practices, ultimately aiming to enhance research transparency, reproducibility, and public access to federally funded research outputs.
31 changes: 31 additions & 0 deletions docs/open/scholarship.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
id: open-scholarship
title: Open Scholarship
custom_edit_url: null
---

Open scholarship is a concept that extends the principles of openness beyond scientific research to encompass all scholarly activities, including teaching, learning, and public engagement. By embracing open practices, scholars can enhance the accessibility, transparency, and impact of their work, fostering a more inclusive and collaborative academic ecosystem.

Saint Louis University is a member of [HELIOS Open](https://www.heliosopen.org/).

## Key Principles of Open Scholarship

* **Open Access:** Making scholarly publications, educational resources, and research outputs freely available online, without subscription barriers, to facilitate widespread dissemination and knowledge sharing.
* **Open Data:** Sharing research data, along with appropriate metadata and documentation, to enable reuse, validation, and new discoveries across disciplines.
* **Open Source:** Utilizing and contributing to open source software, tools, and platforms, fostering collaboration, transparency, and cost-effectiveness in scholarly practices.
* **Open Peer Review:** Embracing transparent and inclusive peer review processes, where reviews are openly available, promoting accountability and constructive feedback.
* **Open Pedagogy:** Encouraging the creation, adaptation, and sharing of open educational resources (OERs) and open pedagogical practices, fostering equity and innovation in teaching and learning.
* **Open Collaboration:** Engaging in collaborative scholarly practices, fostering interdisciplinary collaborations, and embracing diverse perspectives to tackle complex challenges.
* **Open Science:** Applying open science principles, such as preregistration, reproducible research, and open notebooks, to enhance the transparency and reproducibility of scientific research.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is preregistration?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found the answer later, when reviewing science.md. So there's definitely an overlap between Open Scholarship and Open Science (and other open things). Maybe an opportunity for a Venn diagram to visualize this overlap?


## Key Practices of Open Scholarship

* **Open Publishing:** Utilizing open access publishing models, such as preprints, open journals, and institutional repositories, to disseminate scholarly work freely and widely.
* **Open Educational Practices:** Creating, sharing, and adapting open educational resources (OERs) and adopting open pedagogical approaches that promote student-centered learning and collaboration.
* **Open Knowledge Sharing:** Participating in open knowledge-sharing platforms, such as blogs, social media, and public lectures, to engage with broader audiences and facilitate the exchange of ideas.
* **Open Collaboration Tools:** Embracing open collaboration tools and platforms, such as open-source software, version control systems, and virtual research environments, to facilitate collaborative work.
* **Open Advocacy:** Advocating for open scholarship principles and practices within academic communities, institutions, and funding agencies, promoting cultural shifts toward openness and inclusivity.
* **Open Metrics:** Developing and utilizing alternative metrics (altmetrics) to measure the broader impact of scholarly outputs, beyond traditional citation-based metrics.
* **Open Innovation:** Fostering open innovation by engaging with diverse stakeholders, including industry, policymakers, and the public, to co-create solutions and drive societal impact.

By adopting these principles and practices, scholars can foster a more transparent, collaborative, and inclusive academic ecosystem, enhancing the accessibility, impact, and societal relevance of their work across disciplines and sectors.
27 changes: 27 additions & 0 deletions docs/open/science.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
id: open-science
title: Open Science
custom_edit_url: null
---

Open science is a movement that aims to promote transparency, collaboration, and accessibility in scientific research. By embracing open practices, researchers can enhance the quality, reproducibility, and impact of their work, ultimately accelerating scientific progress and fostering public trust.

## Key Principles of Open Science

* **Open Data:** Sharing research data openly, with appropriate metadata and documentation, to enable reuse, validation, and new discoveries.
* **Open Access:** Making research publications freely available online, without subscription barriers, to facilitate widespread dissemination and knowledge sharing.
* **Open Source:** Utilizing and contributing to open source software and tools, fostering collaboration, transparency, and cost-effectiveness in research practices.
* **Open Peer Review:** Embracing transparent and inclusive peer review processes, where reviews are openly available, promoting accountability and constructive feedback.
* **Open Collaboration:** Engaging in collaborative research practices, fostering interdisciplinary collaborations, and embracing diverse perspectives to tackle complex scientific challenges.
* **Open Education:** Promoting open educational resources and practices, enabling equitable access to knowledge and fostering a culture of lifelong learning.

## Key Practices of Open Science

* **Preregistration:** Publicly registering research plans, hypotheses, and analysis plans before conducting a study to enhance transparency and reduce bias.
* **Reproducible Research:** Documenting and sharing research workflows, code, and data to enable others to reproduce and validate findings.
* **Open Notebooks:** Maintaining open and accessible digital notebooks that capture the entire research process, from conceptualization to analysis and dissemination.
* **Open Licensing:** Applying open licenses (e.g., Creative Commons, Open Source) to research outputs, enabling reuse, adaptation, and downstream applications.
* **Open Advocacy:** Advocating for open science principles and practices within research communities, institutions, and funding agencies, promoting cultural shifts toward openness.
* **Open Metrics:** Developing and utilizing alternative metrics (altmetrics) to measure the broader impact of research outputs beyond traditional citation-based metrics.

By adopting these principles and practices, researchers can foster a more transparent, collaborative, and inclusive scientific ecosystem, ultimately enhancing the quality, reproducibility, and societal impact of scientific research.
74 changes: 74 additions & 0 deletions docs/open/software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
id: open-source-software
title: Open Source Software
custom_edit_url: null
---

[Open source software (OSS)](https://opensource.org/osd) refers to software whose source code is freely available for anyone to use, study, modify, and distribute. This collaborative approach to software development fosters innovation, transparency, and community-driven improvement. The open source movement is guided by a set of principles and practices that promote accessibility, collaboration, and continuous enhancement.

Saint Louis University is an Associate member of the [Linux Foundation](https://www.linuxfoundation.org/).

## Shared Infrastructure

Open source software has become a critical shared infrastructure that underpins many aspects of modern life. From operating systems and web browsers to cloud computing platforms and mobile applications, open source software plays a vital role in powering the digital world. Even proprietary software relies on open source languages, libraries, and operating systems. By leveraging the collective efforts of a global community, open source projects have produced robust, secure, and feature-rich software solutions that are widely adopted and trusted.

The open and collaborative nature of open source development allows for rapid innovation and the ability to address emerging challenges swiftly. This shared infrastructure enables interoperability, vendor independence, and cost-effective solutions, benefiting individuals, businesses, and governments alike.

## Research Software Engineering

In the realm of research, open source software has become a crucial component of research software engineering. Researchers rely on open source tools and libraries for data analysis, visualization, simulation, and computational workflows. By embracing open source practices, researchers can ensure reproducibility, foster collaboration, leverae community contributions, enable customization and extension, and promote open science. By embracing open source software in research, the scientific community can drive innovation, enhance software quality, and contribute to a culture of openness, collaboration, and reproducibility in academia.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the realm of research, open source software has become a crucial component of research software engineering. Researchers rely on open source tools and libraries for data analysis, visualization, simulation, and computational workflows. By embracing open source practices, researchers can ensure reproducibility, foster collaboration, leverae community contributions, enable customization and extension, and promote open science. By embracing open source software in research, the scientific community can drive innovation, enhance software quality, and contribute to a culture of openness, collaboration, and reproducibility in academia.
In the realm of research, open source software has become a crucial component of research software engineering. Researchers rely on open source tools and libraries for data analysis, visualization, simulation, and computational workflows. By embracing open source practices, researchers can ensure reproducibility, foster collaboration, leverage community contributions, enable customization and extension, and promote open science. By embracing open source software in research, the scientific community can drive innovation, enhance software quality, and contribute to a culture of openness, collaboration, and reproducibility in academia.


## Key Principles of Open Source Software

* **Open Access:** The source code of the software is openly accessible, enabling transparency and scrutiny.
* **Free Redistribution:** Open source software can be freely redistributed, without restrictions or royalties.
* **Derived Works:** Modifications and derived works are allowed, encouraging collaborative improvement and customization.
* **Non-Discrimination:** Open source software must be available to anyone, without discrimination against persons, groups, or fields of endeavor.
* **License Compatibility:** Open source licenses should be compatible, allowing for the combination and integration of various open source components.
* **Technology Neutrality:** Open source software should not be restricted to specific technologies or interfaces, promoting interoperability and platform independence.

## Key Practices of Open Source Software Development

* **Code sharing:** Open source software starts with publicly sharing the human-readable code that defines how a piece of software works. Source code is usually published on the internet, and often on popular code sharing platforms such as GitHub, GitLab, or GitTea.
* **Licensing:** Granting an explicit legal license for use of source code is the foundational practice that transforms sharing into open source software. There is significant discussion amongst practitioners about the merits and priorities of different well-known public licenses
* **Community Collaboration:** Open source projects thrive on the contributions and collaboration of a global community of developers, fostering knowledge sharing and collective problem-solving. Good practices for open source software encourage maintainers of a piece of software to include guidance on how to collaborate, including open communication channels.
* **Open Communication:** Maintaining open communication channels (e.g., mailing lists, forums, issue trackers) for community discussions, bug reporting, and feature requests. Usually the maintainers of an open source project will establish infrastructure and patterns for open communication.
* **Version Control:** Utilizing version control systems (e.g., Git) as a technical mechanism to manage code changes, enable collaboration, and track project history. Git is currently the predominant version control tool, and is the foundation for many code sharing platforms.

## Key Practices of Research Software Engineering

Research software engineering involves the development, maintenance, and management of software used in academic and scientific research. Research software engineering improves on naive research software development by embracing rigorous software engineering best practices intended to make projects more sustainable, secure, efficient, and adaptable. There are significant overlaps between research software engineering and open source software in both required practices as well as good practices. To ensure high-quality, reproducible, and sustainable research software, the following practices are commonly employed in research software enineering:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This list is not really unique to research software engineering. These are general good practices of software engineering (with the addition of community engagement, which comes from the open source aspect). I'm not sure what I'm suggesting here, just an observation.

* **Version Control:**
* Utilizing version control systems (e.g., Git) to track changes, enable collaboration, and manage code revisions.
* Encouraging the use of distributed version control systems for improved collaboration and backup capabilities.
* **Automated Testing:**
* Implementing unit tests, integration tests, and regression tests to ensure code correctness and catch regressions early.
* Adopting test-driven development (TDD) and continuous integration (CI) practices for efficient testing and code quality assurance.
* **Code Review:**
* Establishing peer review processes for code contributions, ensuring code quality, maintainability, and adherence to project standards.
* Utilizing code review tools and platforms (e.g., GitHub, GitLab) to streamline the review process and facilitate collaboration.
* **Reproducible Environments:**
* Utilizing container technologies (e.g., Docker, Singularity) to encapsulate software dependencies and ensure reproducible computational environments.
* Leveraging environment management tools (e.g., conda, virtualenv) for managing and isolating dependencies.
* **Code Refactoring and Optimization:**
* Regularly refactoring code to improve maintainability, readability, and performance.
* Profiling and optimizing critical code sections for improved computational efficiency.
* **Continuous Integration and Deployment (CI/CD):**
* Implementing CI/CD pipelines for automated building, testing, and deployment of research software.
* Leveraging CI/CD tools (e.g., Jenkins, Travis CI, GitHub Actions) to streamline software release processes.
* **Release Management:**
* Following structured release cycles and versioning schemes to manage software updates and maintain backwards compatibility.
* Maintaining binary repositories containing each version of released software.
* **Community Engagement:**
* Encouraging community involvement and contributions to research software projects.
* Participating in open source communities, conferences, and workshops to share knowledge and collaborate with others.
* **Documentation:**
* Providing comprehensive documentation, including installation guides, usage instructions, API references, and code comments.
* Adopting documentation tools and platforms (e.g., Read the Docs, Sphinx) for improved readability and discoverability.
* **Software Licensing:**
* Applying appropriate open source licenses (e.g., MIT, Apache, GPL) to research software to enable reuse, redistribution, and collaboration.
* Ensuring compliance with license terms and tracking third-party dependencies and their respective licenses.
* **Software Sustainability:**
* Developing strategies and plans for long-term software maintenance and sustainability.
* Ensuring proper documentation, knowledge transfer, and succession planning for research software projects.
33 changes: 33 additions & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -105,6 +105,39 @@ const config = {
}
]

},
{
type: 'dropdown',
position: 'left',
label: 'Open',
items: [
{
label: 'About \'Open\'',
type: 'doc',
docId: 'open/open',
},
{
label: 'Open Scholarship',
type: 'doc',
docId: 'open/open-scholarship',
},
{
label: 'Open Science',
type: 'doc',
docId: 'open/open-science',
},
{
label: 'Open Data',
type: 'doc',
docId: 'open/open-data',
},
{
label: 'Open Source Software',
type: 'doc',
docId: 'open/open-source-software',
}
]

},
{
type: 'doc',
26 changes: 26 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
@@ -49,6 +49,32 @@ const sidebars = {
},
],
},
{
type: 'category',
label: 'Open',
items: [
{
type: 'doc',
id: 'open/open',
},
{
type: 'doc',
id: 'open/open-scholarship',
},
{
type: 'doc',
id: 'open/open-science',
},
{
type: 'doc',
id: 'open/open-data',
},
{
type: 'doc',
id: 'open/open-source-software',
}
]
},
'portfolio',
],
// */