Brian Jackson

Associate Professor of Physics at Boise State University

  • About
  • Research
    • CV
    • Joining the Boise State Planetary Science Research Group
    • Ultra-short-period planet database
    • The Short Period Planets Group — S(u)PerP(i)G
    • Google Scholar Page
    • Code
  • Teaching
  • Press
  • Extracurricular Activities
    • Field Trips
  • Public Outreach
    • Boise State’s Astronomical Observatory

Writing a Scientific Software Package: Open-Sourcing

Posted by admin on April 22, 2018
Posted in: Data Science. Tagged: coding, python, Writing a Scientific Software Package.

UPDATE (2018 Jun 6) – I’m trying to learn how to use Sphinx to create documentation from source-code docstrings. The Sphinx manual is impressively opaque. Some googling turned up this document, which seems to provide useful details.

UPDATE (2018 Jun 4) – I’ve found some new resources that are much more up-to-date:

  • https://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/
    • Note that this article says to run the following to set up virtualenvwrapper:
      echo “source /usr/local/bin/virtualenvwrapper.sh” >> ~/.zshrcHowever, that file is not located in /usr/local/bin on my Mac (High Sierra 10.13.1). Instead, I followed the instructions here to modify the command as follows:
      echo “source /Users/<username>/anaconda2/bin/virtualenvwrapper.sh” >> ~/.bash_profile
  • https://cookiecutter-pypackage.readthedocs.io/en/latest/

To set up my package so it can be installed via pip, I’m following the somewhat outdated tutorial here – https://python-packaging.readthedocs.io/en/latest/index.html.

I’ll make more notes and update this post as I go along.

Posts navigation

← UT Dallas Physics Colloquium – 2018 Apr 4
Dr. Funky Spoon Comes to Boise State →
  • Twitter: decaelus

    Brian Jackson
    • @theidaho97 I called earlier. No one answered, and there was no way to leave a message. 06:45:44 2021 Apr 9 in reply to theidaho97
    • @JubileeJohn777 @KTVB If freedom in the US is so fragile that asking people to drape a piece of cloth over their fa… https://t.co/KHfIxrN0n4 06:44:55 2021 Apr 9 in reply to JubileeJohn777
    • RT @SnoHD: NOTICE April 9, 2021: New appointments posted for the Boeing Everett Activity Center and Edmonds College mass vaccination sites… 05:07:07 2021 Apr 9
    @decaelus
  • Recent Posts

    • Boise State Geosciences Seminar – 2021 Mar 29
    • Third Thursday Virtual Planetarium Show – 2021 Mar 18
    • First Friday Astronomy – Seeing the Dark Side of the Universe through Cosmic Lenses – 2021 Apr 2
    • Third Thursday Planetarium Show – 2021 Feb 18
    • First Friday Astronomy – Psyche: Journey to a Metallic World – 2021 Mar 5
  • Archives

    • March 2021
    • February 2021
    • January 2021
    • December 2020
    • November 2020
    • October 2020
    • September 2020
    • August 2020
    • July 2020
    • June 2020
    • May 2020
    • April 2020
    • March 2020
    • February 2020
    • January 2020
    • December 2019
    • November 2019
    • October 2019
    • September 2019
    • August 2019
    • July 2019
    • June 2019
    • May 2019
    • April 2019
    • March 2019
    • February 2019
    • January 2019
    • December 2018
    • November 2018
    • October 2018
    • September 2018
    • August 2018
    • July 2018
    • June 2018
    • May 2018
    • April 2018
    • March 2018
    • February 2018
    • January 2018
    • December 2017
    • November 2017
    • October 2017
    • September 2017
    • August 2017
    • July 2017
    • June 2017
    • May 2017
    • April 2017
    • March 2017
    • February 2017
    • January 2017
    • December 2016
    • November 2016
    • October 2016
    • September 2016
    • August 2016
    • July 2016
    • June 2016
    • May 2016
    • April 2016
    • March 2016
    • February 2016
    • January 2016
    • December 2015
    • November 2015
    • October 2015
    • September 2015
    • August 2015
    • July 2015
    • June 2015
    • May 2015
    • April 2015
    • March 2015
    • February 2015
    • January 2015
    • December 2014
    • November 2014
    • October 2014
    • September 2014
    • August 2014
    • July 2014
    • June 2014
    • May 2014
    • April 2014
    • March 2014
    • February 2014
    • January 2014
    • December 2013
    • November 2013
    • October 2013
    • September 2013
    • August 2013
    • July 2013
Proudly powered by WordPress Theme: Parament by Automattic.