Welcome to EasyScience’s documentation!

EasyScience is the foundation of the EasyScience universe, providing the building blocks for libraries and applications which aim to make scientific data simulation and analysis easier.

Features of EasyScience

Free and open-source Anyone is free to use EasyScience and the source code is openly shared on GitHub.

• Cross-platform - EasyScience is written in Python and available for all platforms.

• Various techniques - EasyScience has been used to build various libraries such as easyDiffraction and easyReflectometry.

• Advanced built-in features - EasyScience provides features such as model minimization, automatic script generation, undo/redo, and more.

Projects using EasyScience

EasyScience is currently being used in the following projects:

Scientific software for modelling and analysis of neutron diffraction data.

Scientific software for modelling and analysis of neutron reflectometry data.

Documentation

Getting Started

• Overview
• Installation
  • Install via pip
  • Install as an EasyScience developer

Base Classes

• Parameters and Objects
  • Descriptors
    • Descriptor
  • Parameters
    • Parameter
• Super Classes and Collections
  • Super Classes
    • BasedBase
    • BaseObj
  • Collections
    • BaseCollection
• Data Containers
  • EasyScienceDataarrayAccessor
    • EasyScienceDataarrayAccessor.compute_func
    • EasyScienceDataarrayAccessor.core_object
    • EasyScienceDataarrayAccessor.fit()
    • EasyScienceDataarrayAccessor.fit_prep()
    • EasyScienceDataarrayAccessor.generate_points()
    • EasyScienceDataarrayAccessor.postcompute_func
    • EasyScienceDataarrayAccessor.precompute_func
  • EasyScienceDatasetAccessor
    • EasyScienceDatasetAccessor.add_coordinate()
    • EasyScienceDatasetAccessor.add_variable()
    • EasyScienceDatasetAccessor.core_object
    • EasyScienceDatasetAccessor.description
    • EasyScienceDatasetAccessor.fit()
    • EasyScienceDatasetAccessor.generate_points()
    • EasyScienceDatasetAccessor.name
    • EasyScienceDatasetAccessor.remove_coordinate()
    • EasyScienceDatasetAccessor.remove_variable()
    • EasyScienceDatasetAccessor.sigma_attach()
    • EasyScienceDatasetAccessor.sigma_generator()
    • EasyScienceDatasetAccessor.url

Fitting

• Fitting in EasyScience
• Constraints
  • Anatomy of a constraint
    • Constraints on Parameters
    • Constraints on Fitting
  • Using constraints
  • Constraint Reference
    • Built-in constraints
    • User created constraints

Example galleries

• Subclassing Examples
• Fitting Examples

Indices and tables

• Index

• Module Index

• Search Page