Home

Welcome to the python-skeleton wiki!

Table of Contents:

• Python Development
  • Setting Up a Conda Virtual Environment
  • Developing a Python module with setup.py
  • Testing the Python module with unittest
  • Profiling the Python module
  • Documenting Python Files with sphinx
• C++ Development
  • C++ integration with Cythonize
  • Building C++ Files with cmake
  • Testing C++ Files with CXX_TEST
  • Debugging C++ Files with gdb
  • Connecting Numpy to Eigen
• Notebook and Script Experiments
  • Jupyter Notebook Workflow
• LaTeX

--

Project Structure

The folder structure of the project is as follows:

• src/ - Python and Cython Modules
• docs/ - Module documentation
  • docs/source - documentation source files
  • docs/build - final documentation html files
• data/ - Datasets
  • data/raw - raw original data
  • data/processed - preprocessed model-ready data
• tex/ - LaTeX papers, presentations, and notes
  • Write ups have a figure, data, and script directory.
• notebooks/ - Experiments directory with Jupyter notebooks
  • notebooks/develop - Work-in-progress notebooks of the form <Date>-<2-4 Word Description>
  • notebooks/publish - Final polished notebooks
  • Individual notebooks have separate directories (with utility scripts, figures, pickled model, and output)
• experiments/

Useful References

• http://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/