jetson-stats is a community-maintained project and we happily accept contributions.
If you want to add a new Jetpack release follow these quick rules or if you want make a new feature or fix a bug you are on the right page.
Add a new Jetpack#
If you want to add a new Jetpack to fix the warning:
Open file jtop/core/jetson_variables.py around line 49 there is a variable called NVIDIA_JETPACK add the new jetpack following the rule below:
Increase with a minor release jtop variable __version__ in jtop/__init__.py
Create a pull request and append
&template=jetpack-missing.mdto the URL before submitting in order to include our release checklist in the pull request description.
Open a pull request with message “Jetpack Release <VERSION>” where <VERSION> is the same release in jtop/__init__.py
Follow the checklist!
Add new feature or fix a bug#
If you wish to add a new feature or fix a bug:
Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug. There is a Contributor Friendly tag for issues that should be ideal for people who are not very familiar with the codebase yet.
Fork the jetson-stats repository on Github to start making your changes.
Write a test which shows that the bug was fixed or that the feature works as expected.
Send a pull request and bug the maintainer until it gets merged and published.
Setting up your developing environment#
Clone and build in developer mode jetson-stats
git clone https://github.com/rbonghi/jetson_stats.git cd jetson_stats sudo pip3 install -v -e .
Manually stop and disable jtop service#
If you want to manually control the jtop service you need to disable the service and manually start one in a terminal, following the commands below
sudo systemctl stop jtop.service sudo systemctl disable jtop.service
Now you can work running in your terminal the jtop service
sudo JTOP_SERVICE=True jtop --force
Restore jtop service#
sudo systemctl enable jtop.service sudo systemctl start jtop.service
Test this package#
Before commit you can test jetson-stats on multiple python version and check if the documentation is built
This script works with docker, and you can quickly run it.
When you run this script will do:
Build and compile all python images (2.7,3.6,3.7,3.8,22.214.171.124,3.11)
Build documentation image (Sphinx)
There are different options:
Live docker with tox#
Run tox or work live from the terminal
bash tests/local_test.sh --debug -py 3.9
If you want to run only the documentation:
bash tests/local_test.sh --doc
If you want to test or develop the GUI library
You can run this command from your terminal python3 -m jtop.tests_gui.x where x is the name of the file, example
python3 -m jtop.tests_gui.gui_page