How to open source your academic work in 7 steps | Opensource.com

How to open source your academic work in 7 steps

Open source technology and academia are the perfect match. Find out how to meet tenure requirements while benefiting the whole community.

Document sending
Image by : 
Opensource.com
x

Subscribe now

Get the highlights in your inbox every week.

Academic work fits nicely into the open source ethos: The higher the value of what you give away, the greater your academic prestige and earnings. Professors accomplish this by sharing their best ideas for free in journal articles in peer-reviewed literature. This is our currency, without a strong publishing record not only would our ability to progress in our careers degrade, but even our jobs could be lost (and the ability to get any other job).

This situation makes attribution or credit for developing new ideas and technologies critical to an academic, and it must be done in the peer-reviewed literature. Many young academics struggle with how to pull this off while working with an open source community and keeping their academic publishing record strong. There does not need to be a conflict. In fact, by fully embracing open source, there are distinct advantages (e.g., it is hard to get scooped by unethical reviewers when you have a time- and date-stamped open access preprint published for all the world to see).

The following seven steps provide the best practices for making an academic’s work open source. Start by using best practices (e.g., General Design Procedure for Free and Open-Source Hardware for Scientific Equipment), then when your work is ready to share, do the first three steps simultaneously.

Note: Academics should not be concerned about working in open source at all at this point, as open source is now mainstream academia in software and has even been embraced by the hardware community.

Step 1: Select a relevant peer-reviewed journal

Your work should first be published as a technology paper in a peer-reviewed journal with a good reputation (e.g., by Impact Factor or CiteScore, which is a measure reflecting the yearly average number of citations to recent articles published in that journal). If yours is a hardware project, then choose journals such as:

You could also choose a discipline-specific journal that publishes hardware.

Or, if your project is software, then the following journals may be of interest:

Step 2: Post your source code

When submitting your work to a peer-reviewed journal, you will need to post your source code and cite it in your paper. For software papers, you would post your actual code, but for hardware papers, you would post aspects like the bill of materials, CAD designs, build instructions, etc.

Use common websites for sharing code like GitLab, or websites meant specifically for academia like the Open Science Framework.

Step 3: Publish an open access pre-print

When your paper is complete and you submit it to the journal, publish an open-access preprint as well. Doing so protects you against others scooping or patenting your ideas, while at the same time opening all of your work including the paper itself.

Almost all major publishers allow preprints. There are a lot of pre-print servers for every discipline (e.g., arXiv, preprints.org).

Step 4: Start (or select) a company

The next step is not strictlly mandatory, but it is useful to either commercialize your work or provide support for your open source software. Start a spin-off company (or have a student do it), or work with an existing open source company. This step is recommended because although some people will fabricate your device from open source plans or compile your code, the vast majority would rather buy a reasonably priced version that is both open source so they control it, but also assembled or compiled, ready to use, and supported.

Step 5: Certify your project

As soon as the paper is accepted, send it in for certification. See: The trials of certifying open source software, or the perhaps more straightforward OSHWA open hardware certification, for more information. You could do this step earlier, but publishing outside of a preprint server runs risks of being auto-rejected due to the plagiarism checks run by some journals.

Step 6: Prepare a press release

As soon as certification comes through, organize a press release between the company and the university—and embargo it to the date of the academic paper’s official publication. This action spreads information about your open source technology and its benefits as far as possible.

Step 7: Use your own technology

Last, but not least—use your open source technology in future research. From here on out, an academic can publish normally (e.g., do a scientific study using the open hardware and publish in a discipline-specific journal). Of course, preference should be given to open access journals.

Step up

These seven steps are reasonably straightforward for new open source technology projects. When it comes to academics working on existing open source projects, it’s a bit different. They need to carve out an area such as an upgrade to existing open hardware, or a new feature for free and open source software (FOSS), that they can publish on independently. They can then follow the same steps as above while integrating their work back into the community’s code (e.g., back in Step 2).

Following these steps enables academics to more than meet the academic requirements they need for tenure and promotion while developing open source technology for everyone’s benefit.

Release early, replace often?

A few months ago, opensource.com ran a story on a textbook for college students learning...
open source your university

When academia and open source collaborate, everybody wins. Open source projects get new...

Topics

About the author

Joshua Pearce
Joshua Pearce - Dr. Joshua Pearce is cross appointed as a Professor in the Materials Science & Engineering and the Electrical & Computer Engineering at Michigan Tech. He currently runs the Michigan Tech in Open Sustainability Technology (MOST) group. He is the author of the Open Source Lab. His research focuses on open and applied sustainability, which is the application of science and innovation to ensure a better quality of life for all, now and into the future, in a just and equitable manner, whilst...