ARTIFACT Resources Portal - User Guide

Complete guide to browsing, searching, and contributing resources

ARTIFACT Resources Portal - User Guide

Welcome to the ARTIFACT Resources Portal! This guide will help you navigate, search, and contribute to our comprehensive collection of AI/ML resources for particle accelerator physics.

Table of Contents

  1. Overview
  2. Browsing Resources
  3. Resource Categories
  4. Searching and Filtering
  5. Understanding Status Indicators
  6. Viewing Resource Details
  7. Submitting Resources
  8. Featured Resources
  9. Using Topics/Tags

Overview

The ARTIFACT Resources Portal provides a centralized hub for discovering datasets, software tools, training materials, documentation, publications, guidelines, and external resources related to AI/ML applications in accelerator physics.

Key Features:

  • 📊 Organized by category - Seven distinct resource types
  • 🔍 Advanced search - Filter by status, search across all fields
  • 🏷️ Topic-based browsing - Find resources by research area
  • ✅ Quality indicators - Color-coded status badges
  • 🌓 Dark/Light modes - Comfortable viewing in any lighting

Browsing Resources

Accessing the Resources Portal

  1. Navigate to the Resources section from the main menu
  2. You’ll see the Category Grid showing all seven resource types
  3. Each card displays:
    • Category icon and name
    • Brief description
    • Number of available resources

Viewing a Category

Click on any category card to view resources in that category. You’ll see:

  • Back to Categories button - Returns to the category grid
  • Search box - Search within the category
  • Status filter - Filter by resource status
  • Clear Filters button - Reset all filters
  • Results count - Number of resources displayed
  • Resource table - Detailed information for each resource

Resource Categories

💾 Datasets

FAIR-compliant datasets for ML training

Datasets contain experimental or simulated data formatted for machine learning applications.

Typical fields shown:

  • Title (clickable link)
  • Facility/Origin
  • Topics
  • Size
  • License
  • Status badge
  • Submission date

Example use cases:

  • Training neural networks for beam diagnostics
  • Benchmarking ML algorithms
  • Reproducible research

⚙️ Software & Tools

Open-source packages for accelerator ML

Software libraries, frameworks, and tools for accelerator physics applications.

Typical fields shown:

  • Title (clickable link)
  • Programming language
  • Topics
  • Version
  • Maintainer
  • Status badge
  • Submission date

Example use cases:

  • Control system integration
  • Real-time optimization
  • Data analysis pipelines

🎓 Training Materials

Courses, tutorials, and learning content

Educational resources for learning AI/ML applications in accelerator physics.

Typical fields shown:

  • Title (clickable link)
  • Topics
  • Provider
  • Status badge
  • Submission date

Example use cases:

  • Self-paced learning
  • Workshop materials
  • Student training

📖 Documentation

Guides and best practices

Technical documentation, how-to guides, and reference materials.

Typical fields shown:

  • Title (clickable link)
  • Topics
  • Author
  • Status badge
  • Submission date

Example use cases:

  • Installation guides
  • API documentation
  • Best practice recommendations

📄 Publications

Research papers and reports

Academic publications, conference papers, and technical reports.

Typical fields shown:

  • Title (clickable link)
  • Abstract
  • Authors
  • DOI (if available)
  • Status badge
  • Submission date

Example use cases:

  • Literature review
  • Citation references
  • Latest research findings

📋 Community Guidelines

Standards and governance documents

Policies, standards, and governance documents for the ARTIFACT community.

Typical fields shown:

  • Title (clickable link)
  • Topics
  • Organization
  • Status badge
  • Submission date

Example use cases:

  • Understanding community policies
  • Contribution guidelines
  • Data management standards

🔗 External Resources

Partner networks and links

Links to external websites, databases, and partner resources.

Typical fields shown:

  • Title (clickable link)
  • Description
  • Organization
  • Status badge
  • Submission date

Example use cases:

  • Discovering related projects
  • Accessing partner databases
  • Finding complementary tools

Searching and Filtering

The search function looks across multiple fields:

  • Title - Resource names
  • Subtitle/Description - Brief descriptions
  • Maintainer - Author/organization names
  • Topics - All associated tags
  • License - License types (for datasets/software)
  • Language - Programming languages (for software)

How to search:

  1. Click into a category (e.g., Software & Tools)
  2. Type your search term in the search box
  3. Results update automatically as you type
  4. Search is case-insensitive

Example searches:

  • "python" - Finds Python software and tools
  • "beam dynamics" - Finds resources about beam dynamics
  • "neural" - Finds neural network-related resources
  • "CERN" - Finds resources from CERN

Using Status Filters

Filter resources by their current status:

  1. Select a status from the dropdown:

    • All Status (default)
    • Active
    • Beta
    • Draft
    • Completed
    • Planning
    • Archived

  2. The table updates to show only matching resources

  3. Click Clear Filters to reset

Combining Search and Filters

You can use both search and status filters simultaneously:

  1. Enter a search term (e.g., “optimization”)
  2. Select a status filter (e.g., “Active”)
  3. See only active resources matching “optimization”

Understanding Status Indicators

Resources display color-coded status badges indicating their current state:

🟢 Active

Green badge

  • Currently maintained and available
  • Recommended for production use
  • Actively supported

🟡 Beta

Yellow/Orange badge

  • In testing or early release phase
  • May have bugs or incomplete features
  • Feedback welcome

🟡 Draft

Yellow/Orange badge

  • Still being written or developed
  • Not yet ready for general use
  • Preview available

🔵 Completed

Blue badge

  • Finished project or finalized resource
  • No longer under active development
  • Fully functional and stable

🟣 Planning

Purple badge

  • In planning/design stage
  • Not yet implemented
  • May accept early feedback

⚪ Archived

Gray badge

  • No longer maintained
  • May be outdated
  • Kept for historical reference

⚪ Deprecated

Gray badge

  • Superseded by newer resource
  • Not recommended for new projects
  • Migration guide may be available

Viewing Resource Details

Accessing Individual Resources

Click on any resource title in the table to view its detailed page.

Resource Detail Page Layout

Left: Main Content

The main content area includes:

  • Title and Description - Full resource overview
  • Detailed Content - Comprehensive information
  • Action Buttons (if available):
    • Visit Resource - External link to the resource
    • View on GitHub - Source code repository
    • Documentation - Additional documentation
  • Key Features - Highlighted capabilities
  • Downloads & Access - Available files/links

Right: Quick Info Sidebar

The sidebar displays metadata specific to the resource type:

Common fields:

  • Maintainer/Author
  • Contact email
  • License
  • Last updated

Category-specific fields:

Datasets:

  • Facility/Origin
  • Format
  • Size
  • DOI

Software:

  • Programming language
  • Version
  • Repository link

Publications:

  • Authors
  • Abstract
  • DOI/Document link
  • Keywords

Additional sections:

  • Tags - Related topics
  • Related Resources - Similar or complementary resources
  • Back to All Resources button

Submitting Resources

How to Submit

  1. Click the "➕ Submit Resource" button in the sidebar
  2. You’ll be directed to the submission form

Submission Form Sections

📝 Basic Information (Required)

  • Resource Title - Clear, descriptive name
  • Short Description - One-line summary
  • Category - Select from dropdown

🔖 Metadata

Fields displayed based on your selected category:

For Datasets:

  • Generation origin (facility/experiment)
  • Format (HDF5, CSV, etc.)
  • Size
  • DOI (if available)
  • License
  • Status

For Software:

  • Programming language
  • Version
  • License
  • Repository URL
  • Status

For Training Materials:

  • Provider
  • Topics
  • Status

For Documentation:

  • Author
  • Topics

For Publications:

  • Abstract
  • Authors
  • DOI/Document link
  • Keywords

For Guidelines:

  • Organization
  • Status

For External Resources:

  • Organization
  • External link

📄 Detailed Description (Required)

Comprehensive description in Markdown format. Include:

  • Overview
  • Key features
  • Usage examples
  • Requirements
  • Installation (if applicable)

👤 Contact Information (Required)

  • Your name
  • Email address

Submission Process

  1. Fill out all required fields (marked with *)
  2. Complete category-specific metadata
  3. Write a detailed description
  4. Provide your contact information
  5. Click Submit Resource

What happens next:

  • Your submission is queued for review
  • The moderation team evaluates your resource
  • You’ll be notified when it’s published
  • Resources typically reviewed within 1-2 weeks

Submission Guidelines

✅ Do:

  • Provide accurate, complete information
  • Use clear, professional language
  • Include relevant links and references
  • Test external links before submitting
  • Choose appropriate topics/tags
  • Specify the correct category

❌ Don’t:

  • Submit duplicate resources
  • Use promotional or marketing language
  • Include broken links
  • Submit incomplete information
  • Misrepresent the resource status

The sidebar highlights important community resources:

📚 Living Review

AI/ML for Particle Accelerators

A comprehensive, continuously updated survey of AI/ML applications in accelerator physics.

Features:

  • Regularly updated with new research
  • Categorized by application area
  • Extensive reference list

Access Living Review →

💾 Data Store

Central Data Repository

The ARTIFACT central data repository for storing and sharing datasets.

Features:

  • Secure cloud storage
  • IAM authentication
  • Version control
  • Metadata management

Access Data Store →

Using Topics/Tags

What are Topics?

Topics (also called tags) categorize resources by research area, technology, or application. They help you find related resources across different categories.

How Topics are Displayed

  • In tables: Colored pills showing each topic
  • On resource pages: Tag list in the sidebar
  • Searchable: Include in search terms

Common Topics

Research Areas:

  • beam-dynamics
  • machine-learning
  • optimization
  • diagnostics
  • control-systems

Technologies:

  • neural-networks
  • reinforcement-learning
  • computer-vision
  • time-series

Applications:

  • fault-detection
  • predictive-maintenance
  • anomaly-detection
  • parameter-optimization

Data Types:

  • simulation
  • experimental
  • synthetic

Finding Resources by Topic

  1. Use the search box to search for a topic
  2. Topics are included in the search index
  3. Results show all resources tagged with that topic

Example: Search for “neural-networks” to find:

  • Datasets suitable for neural network training
  • Neural network software libraries
  • Training materials on neural networks
  • Papers using neural networks

Tips and Best Practices

For Resource Seekers

✨ Start broad, then narrow:

  • Browse category first
  • Use status filter to see active resources
  • Search for specific terms if needed

✨ Check multiple categories:

  • A dataset might have related software
  • Training materials might reference publications
  • Guidelines might link to documentation

✨ Use the Living Review:

  • Comprehensive overview of the field
  • Entry point for new users
  • Regularly updated with new content

✨ Follow the links:

  • Related resources in sidebars
  • External links in descriptions
  • DOI links for publications

For Resource Contributors

✨ Be descriptive:

  • Clear titles and descriptions
  • Comprehensive documentation
  • Accurate metadata

✨ Tag appropriately:

  • Use 3-5 relevant topics
  • Choose specific tags
  • Think about discoverability

✨ Keep it updated:

  • Update status as needed
  • Maintain contact information
  • Notify of major changes

✨ Engage with community:

  • Respond to questions
  • Provide examples
  • Accept feedback

Frequently Asked Questions

How often is the portal updated?

Resources are added continuously as they’re submitted and reviewed. The Living Review is updated regularly with new research.

Can I submit resources I didn’t create?

Yes, you can submit third-party resources with proper attribution. Provide accurate contact information for the original creators.

What if I find incorrect information?

Contact the resource maintainer listed in the sidebar, or reach out to the ARTIFACT team at [contact email].

How do I update my submitted resource?

Contact the ARTIFACT moderation team with your updates. Include the resource title and what needs to change.

Can I submit resources in languages other than English?

While English is preferred for accessibility, resources in other languages are accepted if they provide unique value.

What licenses are acceptable?

Open source and open data licenses are encouraged (MIT, Apache, CC-BY, etc.). Proprietary resources can be listed with appropriate restrictions noted.

Use the contact information on the resource page, or report it to the ARTIFACT team.

Getting Help

Need assistance?

  • 📧 Email: [Insert contact email]
  • 💬 Discussion Forum: [Insert forum link]
  • 📖 Documentation: Browse the Documentation category
  • 🤝 Community: Join our partner networks

Found a bug?

  • Report technical issues on GitHub
  • Include browser and version
  • Describe steps to reproduce
  • Include screenshots if helpful

Changelog

Version 1.0 - October 2025

  • Initial release
  • Seven resource categories
  • Search and filter functionality
  • Status indicators
  • Topic-based organization
  • Dark/light theme support

This documentation is maintained by the ARTIFACT team. Last updated: October 7, 2025.