niamoto 0.12.3

No project description provided

Niamoto

A powerful CLI tool for ecological data management and visualization

Transform your ecological data into interactive websites with taxonomic analysis, statistical insights, and beautiful visualizations.

🔗 View Live Demo | 📖 Browse Documentation

🚀 Quick Start

# Install Niamoto
pip install niamoto

# Initialize your project
niamoto init

# Import your data
niamoto import

# Generate statistics
niamoto transform

# Create your website
niamoto export

✨ That's it! Your ecological data website is ready at exports/web/.

🖼️ Screenshots

Taxonomic Index Page

Browse and search through your taxonomic data with interactive filters

Taxon Detail Page

Detailed view with statistics, distributions, and interactive visualizations

✨ Features

• 🌿 Ecological Data Management - Import and manage taxonomic, occurrence, and plot data
• 📊 Statistical Analysis - Built-in plugins for distributions, rankings, and summaries
• 🗺️ Geospatial Analysis - Interactive maps and spatial statistics
• 📈 Data Visualization - Charts, maps, and dashboards with Plotly
• 🏗️ Plugin System - Extensible architecture for custom transformations and generations
• 🌐 Static Site Generation - Generate fast, SEO-friendly websites
• ⚡ CLI Interface - Simple commands for the entire workflow
• 🔧 Configuration-Driven - YAML-based configuration for reproducibility

🎯 Use Cases

Niamoto is perfect for:

• Research Institutions - Manage biodiversity databases and generate research websites
• Conservation Organizations - Track species distributions and create public dashboards
• Botanical Gardens - Document collections and share taxonomic information
• Environmental Consultants - Analyze ecological data and create client reports
• Government Agencies - Monitor biodiversity and publish open data portals

---

📖 Table of Contents

• 🚀 Quick Start
• 🖼️ Screenshots
  • Taxonomic Index Page
  • Taxon Detail Page
• ✨ Features
• 🎯 Use Cases
• 📖 Table of Contents
• 📦 Installation
  • For Users
  • For Developers
• 🏃‍♂️ Usage
  • Initial Setup
  • Data Import
  • Generate Statistics and Website
• 📂 Project Structure
• 🔧 Configuration
• 🧩 Plugin System
• 👩‍💻 Development
• 📚 Documentation
• 🤝 Contributing
• 📄 License
• ❓ FAQ
• 🤝 Community & Support
• 📅 Changelog

📦 Installation

For Users

pip install niamoto

For Developers

# Clone and setup development environment
git clone https://github.com/niamoto/niamoto.git
cd niamoto
uv venv && source .venv/bin/activate
uv pip install -e ".[dev]"

📋 Detailed Installation Guide

🏃‍♂️ Usage

Initial Setup

# Initialize your project
niamoto init

# This creates the default configuration files:
# - config/config.yml     (global settings)
# - config/import.yml     (data sources)
# - config/transform.yml  (data processing)
# - config/export.yml     (website generation)

Data Import

# Import all data sources from import.yml
niamoto import

# Or import specific data types
niamoto import taxonomy <file>
niamoto import occurrences <file>
niamoto import plots <file>

Generate Statistics and Website

# Process data transformations
niamoto transform

# Generate static website
niamoto export

# Your website is ready at exports/web/

📖 Complete CLI Reference | Data Import Guide

📂 Project Structure

config/          - YAML configuration files for data pipeline:
  config.yml     - Global configuration options
  import.yml     - Data import configuration
  transform.yml  - Data transformation configuration
  export.yml     - Widget and chart configurations

db/              - Database files and schemas
exports/         - Generated widget data and statistics
imports/         - Raw data files (CSV, shapefiles, rasters)
logs/            - Application logs and debug information
plugins/         - Custom plugin directory for extending functionality
templates/       - Custom Jinja2 templates for website generation

🔧 Configuration

Niamoto uses YAML configuration files to define your data pipeline:

• config/import.yml - Data sources (CSV, GIS files)
• config/transform.yml - Data processing and statistics
• config/export.yml - Website generation and visualizations

📖 Complete Configuration Guide | Data Import Guide

🧩 Plugin System

Niamoto includes built-in plugins for data transformation and visualization, with support for custom plugins.

📖 Plugin Development Guide | Plugin API Reference

👩‍💻 Development

For development setup, testing, and contribution guidelines:

📖 Development Setup Guide | Contributing Guidelines

📚 Documentation

The complete documentation is available in the docs/ directory and online:

• 📖 Online Documentation
• 🚀 Getting Started Guide
• 📋 Configuration Guide
• 🧩 Plugin Development
• 📖 API Reference
• 🤖 ML Detection System
• 📊 Data Pipeline

To build the documentation locally:

cd docs
sphinx-apidoc -o . ../src/niamoto
make html

🤝 Contributing

We welcome contributions to Niamoto! Here's how you can help:

1. Check for open issues or open a new issue to start a discussion
2. Fork the repository and create your feature branch
3. Write tests for new features and ensure existing tests pass
4. Follow our coding standards (Black formatting, type hints, docstrings)
5. Submit a pull request

📖 Contributing Guide

📄 License

niamoto is distributed under the terms of the GPL-3.0-or-later license.

❓ FAQ

What data formats does Niamoto support?

Niamoto supports CSV files for taxonomic and occurrence data, and common GIS formats (Shapefile, GeoPackage, GeoTIFF) for spatial data.

Can I customize the generated website?

Yes! Niamoto uses Jinja2 templates and supports custom CSS. You can completely customize the look and feel of your website.

How do I add custom data transformations?

You can create custom plugins by extending the base plugin classes. See our Plugin Development Guide.

Is Niamoto suitable for large datasets?

Yes! Niamoto uses SQLite with spatial extensions and is optimized for performance. It can handle datasets with millions of records efficiently.

🤝 Community & Support

• 💬 Discussions - GitHub Discussions
• 🐛 Bug Reports - GitHub Issues
• 📖 Documentation - niamoto.readthedocs.io
• 🔗 Live Demo - niamoto.github.io/niamoto-static-site

📅 Changelog

See CHANGELOG.md for a list of changes in each release.