OpenFisca Python API

Modules:

• 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
  • Simulation
    • Simulation.calculate()
    • Simulation.get_array()
    • Simulation.get_holder()
    • Simulation.get_memory_usage()
  • SimulationBuilder
    • SimulationBuilder.build_default_simulation()
    • SimulationBuilder.build_from_dict()
    • SimulationBuilder.build_from_entities()
    • SimulationBuilder.build_from_variables()
    • SimulationBuilder.explicit_singular_entities()
  • 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
  • Population
    • Population.__call__()
    • Population.get_rank()
    • Population.has_role()
  • 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
  • ComputationLog
    • ComputationLog.print_log()
  • FlatTrace
  • FullTracer
  • PerformanceLog
  • SimpleTracer
  • TraceNode
  • TracingParameterNodeAtInstant
• Enum & EnumArray
  • ENUM_ARRAY_DTYPE
  • Enum
    • Enum.__eq__()
    • Enum.__ne__()
    • 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.__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
  • Container
  • CoreEntity
  • CorePopulation
  • DTypeBool
  • DTypeBytes
  • DTypeDate
  • DTypeEnum
  • DTypeFloat
  • DTypeGeneric
  • DTypeInt
  • DTypeObject
  • DTypeStr
  • DateUnit
  • EntityKey
  • EntityPlural
  • Enum
  • EnumArray
  • EnumType
  • Formula
    • Formula.__call__()
  • GroupEntity
  • GroupPopulation
  • Holder
  • Indexable
  • Instant
  • InstantStr
  • ParameterNodeAtInstant
  • Params
    • Params.__call__()
  • Period
  • PeriodStr
  • Role
  • RoleKey
  • RolePlural
  • Simulation
  • SingleEntity
  • SinglePopulation
  • TaxBenefitSystem
  • Variable
  • VariableName

Scripts:

• 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