Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 3.73 KB

README.md

File metadata and controls

62 lines (44 loc) · 3.73 KB

Fieldtools

version PyPI status license Python 3.8 OS

gif

Table of contents

Description

This repository contains three simple command line applications that I wrote to help with some aspects of my field work. Most of it is very hacky, but it does its job and might be useful to someone else. It is written in Python and Bash, and it has not been tested outside Debian/Ubuntu*.

command description
copy-cards Listens for SD cards and copies and organises their content automatically.
format-cards Format multiple cards at the same time: the program listens for volumes with name matching a pattern and mounts, formats, renames, and unmounts them. Whith an option to check that files have been safely backed up before formatting goes ahead.
fieldwork-helper Enter and check data about recorder deployment in nest boxes with known spatial location. It automatically generates .gpx files with a fieldwork plan for the next day based on up-to-date nest state information. Very specific to my work, but easy to adapt to other sites or projects. Will NOT run as is - it needs private database access keys to work.

*In other words, there is no reason to expect that they will work outside a Debian derivative.

Installation

  1. Clone the repository:
 git clone https://github.com/nilomr/fieldtools.git
  1. Navigate to main project folder, then run:
  conda env create --file requirements.yml && conda activate fieldtools-env
  1. Install source code: pip install . (install) or pip install -e . (developer install).
  2. Make symlinks to scripts to copy/format cards and enter field data. You can change the paths in the bash script file if needed, then run
sudo bash fieldtools/bash/setup.sh
  1. Run conda deactivate if you are still in the newly created 'fieldtools-env' environment.

  2. Edit src/paths.py to include your own project structure and provide a list of the volume names to listen for.

  3. You can now run copy-cards, format-cards or fieldwork-helper from any directory.

To Do

  • Finish refactoring
  • Create a separate 'user settings' file
  • Add documentation

A project by Nilo M. Recalde | 2021