Contributing to MicroSpec¶
Here is a short guide for contributing to microspec
(or modifying for your
own purposes). Skip this section if you are only interested in writing
applications that use microspeclib
.
Setup¶
Clone the repository:
git clone https://github.com/microspectrometer/microspec.git
Install all the packages required for development:
pip install microspec[dev]
Also install socat
(Linux/Mac only) to run unit tests using
the hardware emulator:
sudo apt install socat
If socat
is not installed, pytest
skips unit tests using
the emulator.
Windows users can still run unit tests on actual hardware and rebuild the documentation. Windows users only need access to Linux/Mac to run the unit tests that use the emulator.
Workflow¶
After modifying microspec
:
run unit tests to check all tests still pass
rebuild the documentation
Rebuild documentation¶
Build the docs:
cd microspec/doc
make clean html
View the docs:
cd microspec
browse doc/build/html/index.html