.. NekUpload documentation master file, created by sphinx-quickstart on Wed Feb 12 15:10:52 2025. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. NekUpload Documentation ======================= Managing and sharing `Nektar++ `_ datasets can be complex. **NekUpload** simplifies this process by automating validation, upload, and metadata extraction, ensuring data integrity and promoting FAIR data principles. **NekUpload** is a Python package that verifies and uploads Nektar++ datasets to a specified database or online repository. It provides both a local application and a command-line interface. Key Benefits: * **FAIR Data:** Ensures datasets are Findable, Accessible, Interoperable, and Reusable, promoting open research * **Nektar++ Best Practices:** Enforces consistent data management workflows for Nektar++ datasets * **Metadata Extraction:** Automatically extracts key geometric and aerodynamic features, enhancing dataset discoverability * **Automated Upload and Submission:** Streamlines the verification and upload process, ideal for managing large backlogs of datasets * **User Guidance:** Provides suggestions for completing and ensuring dataset consistency * **User-Friendly Experience:** Upload datasets effortlessly, with built-in guidance for completing and ensuring data consistency * **Simplified Admin Approval:** Facilitates database administrator review and approval of submitted datasets Get Started with NekUpload -------------------------- .. note:: This project is under active development. .. toctree:: :maxdepth: 2 :caption: Contents: user_guide/usage developer_guide/developer _api/modules