Navigation

  • index
  • modules |
  • next |
  • OpenFisca documentation »
  • <no title>
OpenFisca Documentation
  • Before you start
  • Architecture of OpenFisca
  • Getting started
  • Key concepts
  • From law to code
  • Running a simulation
  • OpenFisca Python API
  • OpenFisca web API
  • To find help
  • Training materials
  • Contribute
  • Licence
  1. Docs
  2. <no title>
  • Before you start
    • What is OpenFisca
    • Who uses OpenFisca
    • Way to use OpenFisca
      • 1 - Use an available country package or roll your own
      • 2 - Identify the input data you need
      • 3 - Run Simulations
    • What OpenFisca will not do for you
      • Behaviour-based analysis
      • Human decisions
      • Zero effort modelling
      • Magical legislation parsing
      • Textual comparisons
    • Feeling lost?
  • Architecture of OpenFisca
    • Country Packages
    • Extensions Packages
    • Core
    • Templates
  • Getting started
    • 1) Identify the country package
    • 2) Clarify use case
      • Utilising existing rules
        • Web API
        • Python API
      • Contributing to the rules
    • Edge cases
  • Key concepts
  • From law to code
    • Tutorial
    • Additional documentation
  • Running a simulation
  • OpenFisca Python API
    • Commons
      • Dummy
      • apply_thresholds()
      • average_rate()
      • concat()
      • empty_clone()
      • eval_expression()
      • marginal_rate()
      • stringify_array()
      • switch()
    • Data Storage
      • InMemoryStorage
        • InMemoryStorage.delete()
        • InMemoryStorage.get()
        • InMemoryStorage.get_known_periods()
        • InMemoryStorage.get_memory_usage()
        • InMemoryStorage.is_eternal
        • InMemoryStorage.put()
      • OnDiskStorage
        • OnDiskStorage._decode_file()
        • OnDiskStorage.delete()
        • OnDiskStorage.get()
        • OnDiskStorage.get_known_periods()
        • OnDiskStorage.is_eternal
        • OnDiskStorage.preserve_storage_dir
        • OnDiskStorage.put()
        • OnDiskStorage.restore()
        • OnDiskStorage.storage_dir
    • TaxBenefitSystem
      • TaxBenefitSystem
        • TaxBenefitSystem.parameters
        • TaxBenefitSystem.add_variable()
        • TaxBenefitSystem.add_variables()
        • TaxBenefitSystem.add_variables_from_directory()
        • TaxBenefitSystem.add_variables_from_file()
        • TaxBenefitSystem.apply_reform()
        • TaxBenefitSystem.get_package_metadata()
        • TaxBenefitSystem.get_parameters_at_instant()
        • TaxBenefitSystem.get_variable()
        • TaxBenefitSystem.get_variables()
        • TaxBenefitSystem.load_extension()
        • TaxBenefitSystem.load_parameters()
        • TaxBenefitSystem.neutralize_variable()
        • TaxBenefitSystem.replace_variable()
        • TaxBenefitSystem.update_variable()
    • Variables
      • Variable
        • Variable.name
        • Variable.value_type
        • Variable.entity
        • Variable.definition_period
        • Variable.formulas
        • Variable.label
        • Variable.reference
        • Variable.default_value
        • Variable.baseline_variable
        • Variable.dtype
        • Variable.end
        • Variable.is_neutralized
        • Variable.json_type
        • Variable.max_length
        • Variable.possible_values
        • Variable.set_input
        • Variable.unit
        • Variable.documentation
        • Variable.get_formula()
        • Variable.is_input_variable()
        • Variable.parse_formula_name()
      • get_annualized_variable()
      • get_neutralized_variable()
    • Parameters
      • AtInstantLike
      • Parameter
        • Parameter.values_list
        • Parameter.update()
      • ParameterAtInstant
      • ParameterNode
        • ParameterNode.add_child()
        • ParameterNode.get_descendants()
        • ParameterNode.merge()
      • ParameterNodeAtInstant
      • ParameterScale
      • ParameterScaleBracket
      • VectorialParameterNodeAtInstant
        • VectorialParameterNodeAtInstant.check_node_vectorisable()
      • load_parameter_file()
    • Reforms
      • Reform
        • Reform.modify_parameters()
    • Simulations
      • SimulationBuilder
        • SimulationBuilder.build_default_simulation()
        • SimulationBuilder.build_from_dict()
        • SimulationBuilder.build_from_entities()
        • SimulationBuilder.build_from_variables()
        • SimulationBuilder.explicit_singular_entities()
      • Simulation
        • Simulation.calculate()
        • Simulation.get_array()
        • Simulation.get_holder()
        • Simulation.get_memory_usage()
      • check_unexpected_entities()
      • has_unexpected_entities()
    • Entities
      • CoreEntity
        • CoreEntity.check_role_validity()
        • CoreEntity.check_variable_defined_for_entity()
        • CoreEntity.doc
        • CoreEntity.get_variable()
        • CoreEntity.is_person
        • CoreEntity.key
        • CoreEntity.label
        • CoreEntity.plural
        • CoreEntity.set_tax_benefit_system()
      • Entity
        • Entity.check_role_validity()
        • Entity.check_variable_defined_for_entity()
        • Entity.doc
        • Entity.get_variable()
        • Entity.is_person
        • Entity.key
        • Entity.label
        • Entity.plural
        • Entity.set_tax_benefit_system()
      • GroupEntity
        • GroupEntity.check_role_validity()
        • GroupEntity.check_variable_defined_for_entity()
        • GroupEntity.doc
        • GroupEntity.get_variable()
        • GroupEntity.is_person
        • GroupEntity.key
        • GroupEntity.label
        • GroupEntity.plural
        • GroupEntity.roles
        • GroupEntity.set_tax_benefit_system()
      • Role
        • Role.description
        • Role.doc
        • Role.entity
        • Role.key
        • Role.label
        • Role.max
        • Role.plural
        • Role.subroles
      • SingleEntity
      • build_entity()
      • check_role_validity()
      • find_role()
    • Populations
      • CorePopulation
        • CorePopulation.__call__()
      • SinglePopulation
      • GroupPopulation
        • GroupPopulation.all()
        • GroupPopulation.any()
        • GroupPopulation.max()
        • GroupPopulation.min()
        • GroupPopulation.nb_persons()
        • GroupPopulation.sum()
    • tools.test_runner
      • ErrorMargin
      • Options
      • Test
      • YamlFile
        • YamlFile.collect()
        • YamlFile.config
        • YamlFile.name
        • YamlFile.parent
        • YamlFile.path
        • YamlFile.session
      • run_tests()
    • Tracer
      • SimpleTracer
        • SimpleTracer.record_calculation_end()
        • SimpleTracer.record_calculation_result()
        • SimpleTracer.record_calculation_start()
        • SimpleTracer.record_parameter_access()
        • SimpleTracer.stack
      • TraceNode
        • TraceNode.append_child()
        • TraceNode.calculation_time()
        • TraceNode.children
        • TraceNode.end
        • TraceNode.formula_time()
        • TraceNode.name
        • TraceNode.parameters
        • TraceNode.parent
        • TraceNode.period
        • TraceNode.round()
        • TraceNode.start
        • TraceNode.value
    • Enum & EnumArray
      • ENUM_ARRAY_DTYPE
      • Enum
        • Enum.__new__()
        • Enum.encode()
        • Enum.index
      • EnumArray
        • EnumArray.__array_finalize__()
        • EnumArray.__eq__()
        • EnumArray.__ne__()
        • EnumArray.__new__()
        • EnumArray.decode()
        • EnumArray.decode_to_str()
        • EnumArray.possible_values
      • EnumEncodingError
      • EnumMemberNotFoundError
      • EnumType
        • EnumType.__eq__()
        • EnumType.__ne__()
        • EnumType.__new__()
    • Holders
      • Holder
        • Holder.clone()
        • Holder.default_array()
        • Holder.delete_arrays()
        • Holder.get_array()
        • Holder.get_known_periods()
        • Holder.get_memory_usage()
        • Holder.set_input()
      • set_input_dispatch_by_period()
      • set_input_divide_by_period()
    • Simulation generator
      • make_simulation()
      • randomly_init_variable()
    • Periods
      • Instant
      • instant()
      • instant_date()
      • key_period_size()
      • period()
      • unit_weight()
      • unit_weights()
    • Errors
      • CycleError
      • EmptyArgumentError
      • NaNCreationError
      • ParameterNotFoundError
      • ParameterParsingError
      • PeriodMismatchError
      • SituationParsingError
      • SpiralError
      • VariableNameConflictError
      • VariableNotFoundError
    • Types
      • Array
      • ArrayLike
      • BoolArray
      • BytesArray
      • ComputationLog
      • Container
      • CoreEntity
      • CorePopulation
      • DTypeBool
      • DTypeBytes
      • DTypeDate
      • DTypeEnum
      • DTypeFloat
      • DTypeGeneric
      • DTypeInt
      • DTypeObject
      • DTypeStr
      • DateArray
      • DateUnit
      • EntityKey
      • EntityPlural
      • Enum
      • EnumArray
      • EnumType
      • FlatNodeMap
      • FlatTrace
      • FlatTraceMap
      • FloatArray
      • Formula
        • Formula.__call__()
      • FullTracer
      • GroupEntity
      • GroupPopulation
      • Holder
      • ISOCalendarStr
      • ISOFormatStr
      • IndexArray
      • Indexable
      • Instant
      • InstantInt
      • InstantStr
      • IntArray
      • MemoryUsage
      • NodeKey
      • ObjArray
      • ParameterNode
      • ParameterNodeAtInstant
      • ParameterNodeChild
      • Params
        • Params.__call__()
      • PerformanceLog
      • Period
      • PeriodInt
      • PeriodLike
      • PeriodStr
      • Role
      • RoleKey
      • RolePlural
      • SeqInt
      • SerializedNodeMap
      • SerializedTraceMap
      • SimpleStack
      • SimpleTraceMap
      • SimpleTracer
      • Simulation
      • SingleEntity
      • SinglePopulation
      • StrArray
      • TaxBenefitSystem
      • Time
      • TraceNode
      • VarArray
      • Variable
      • VariableName
      • VectorialParameterNodeAtInstant
      • iso_calendar
      • iso_format
    • openfisca test
      • Positional Arguments
      • Named Arguments
      • Examples
        • Basic use
        • Error margin
        • Name filter
        • Extensions
        • Reforms
    • openfisca serve
      • Named Arguments
      • Additional arguments
      • Examples
        • Basic use
        • Serving extensions
        • Serving reforms
        • Using a configuration file
        • Using gunicorn directly
  • OpenFisca web API
    • Demonstration API
    • OpenFisca country APIs
    • Example use cases
    • Conditions
    • Hosting an API instance
      • Track your API
  • To find help
    • Slack
      • Channels and Naming conventions
    • Contact
  • Training materials
    • Slide decks
      • Pre Training: Kick-off
      • Session 1: RaC Background
      • Session 2: Getting started
      • Session 3: Modelling legislation​
      • Session 4: Using the web API​
      • Session 5: Using the Python API​
      • Session 6: Data interconnection​​
      • Session 7: Updating the model​​
      • Session 8: Designing policy​​​
    • Videos
      • Pre Training: Kick-off
      • Session 1: RaC Background
      • Session 2: Getting started
      • Session 3: Algorithmic transparency
      • Session 4: Using the web API
      • Session 5: Using the Python API
    • Workshops
      • Building an OpenFisca-powered web application
        • Session 1: Introduction to the Web API
        • Session 2: Web App Bootstrap
        • Session 3: Calculate Income Tax With Svelte
        • Session 4: Calculate Disposable Income With React
        • Session 5: Expand Disposable Income Over Axes With VueJS and D3
    • Credit
  • Contribute
    • Why contribute to OpenFisca?
    • How to contribute?
      • Use the API and direct its development
      • Test and report errors (web API)
      • Complete the implementation of the French tax and benefit system
      • Write some legislation
      • Write reforms
      • Enhance other projects linked to OpenFisca
  • Licence
    • Computation results
      • English
      • Français
    • Hosting an API instance
      • English
      • Français
    • Changes

Navigation

  • index
  • modules |
  • next |
  • OpenFisca documentation »
  • <no title>
© Copyright . Created using Sphinx.