# pylimer_tools package

## Subpackages

* [pylimer_tools.calc package](pylimer_tools.calc.html.md)
  * [Submodules](pylimer_tools.calc.html.md#submodules)
  * [pylimer_tools.calc.mehp_utilities module](pylimer_tools.calc.html.md#module-pylimer_tools.calc.mehp_utilities)
    * [`compute_cycle_rank()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.compute_cycle_rank)
    * [`compute_effective_nr_density_of_junctions()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.compute_effective_nr_density_of_junctions)
    * [`compute_effective_nr_density_of_network()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.compute_effective_nr_density_of_network)
    * [`compute_mean_universe_volume()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.compute_mean_universe_volume)
    * [`compute_topological_factor()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.compute_topological_factor)
    * [`predict_shear_modulus()`](pylimer_tools.calc.html.md#pylimer_tools.calc.mehp_utilities.predict_shear_modulus)
  * [pylimer_tools.calc.miller_macosko_theory module](pylimer_tools.calc.html.md#module-pylimer_tools.calc.miller_macosko_theory)
    * [`compute_entanglement_modulus()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_entanglement_modulus)
    * [`compute_extracted_modulus()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_extracted_modulus)
    * [`compute_junction_modulus()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_junction_modulus)
    * [`compute_miller_macosko_probabilities()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_miller_macosko_probabilities)
    * [`compute_modulus_decomposition()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_modulus_decomposition)
    * [`compute_probability_that_bifunctional_monomer_is_dangling()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_probability_that_bifunctional_monomer_is_dangling)
    * [`compute_probability_that_bifunctional_monomer_is_effective()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_probability_that_bifunctional_monomer_is_effective)
    * [`compute_probability_that_crosslink_is_dangling()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_probability_that_crosslink_is_dangling)
    * [`compute_probability_that_crosslink_is_effective()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_probability_that_crosslink_is_effective)
    * [`compute_probability_that_crosslink_with_degree_is_dangling()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_probability_that_crosslink_with_degree_is_dangling)
    * [`compute_trapping_factor()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_trapping_factor)
    * [`compute_weight_fraction_of_backbone()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_weight_fraction_of_backbone)
    * [`compute_weight_fraction_of_dangling_chains()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_weight_fraction_of_dangling_chains)
    * [`compute_weight_fraction_of_soluble_material()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_weight_fraction_of_soluble_material)
    * [`compute_weight_fraction_of_soluble_material_from_weight_fractions()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.compute_weight_fraction_of_soluble_material_from_weight_fractions)
    * [`predict_gelation_point()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_gelation_point)
    * [`predict_maximum_p()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_maximum_p)
    * [`predict_number_density_of_junction_points()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_number_density_of_junction_points)
    * [`predict_number_density_of_network_strands()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_number_density_of_network_strands)
    * [`predict_p_from_w_sol()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_p_from_w_sol)
    * [`predict_shear_modulus()`](pylimer_tools.calc.html.md#pylimer_tools.calc.miller_macosko_theory.predict_shear_modulus)
  * [pylimer_tools.calc.stoichiometric_relationships module](pylimer_tools.calc.html.md#module-pylimer_tools.calc.stoichiometric_relationships)
    * [`compute_number_fractions()`](pylimer_tools.calc.html.md#pylimer_tools.calc.stoichiometric_relationships.compute_number_fractions)
    * [`compute_strand_number_density()`](pylimer_tools.calc.html.md#pylimer_tools.calc.stoichiometric_relationships.compute_strand_number_density)
    * [`compute_weight_fractions()`](pylimer_tools.calc.html.md#pylimer_tools.calc.stoichiometric_relationships.compute_weight_fractions)
  * [pylimer_tools.calc.structure_analysis module](pylimer_tools.calc.html.md#module-pylimer_tools.calc.structure_analysis)
    * [`compute_crosslinker_conversion()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_crosslinker_conversion)
    * [`compute_effective_crosslinker_functionalities()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_effective_crosslinker_functionalities)
    * [`compute_effective_crosslinker_functionality()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_effective_crosslinker_functionality)
    * [`compute_end_to_end_vectors()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_end_to_end_vectors)
    * [`compute_extent_of_reaction()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_extent_of_reaction)
    * [`compute_fraction_of_bifunctional_reactive_sites()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_fraction_of_bifunctional_reactive_sites)
    * [`compute_mean_end_to_end_distances()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_mean_end_to_end_distances)
    * [`compute_mean_end_to_end_vectors()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_mean_end_to_end_vectors)
    * [`compute_stoichiometric_imbalance()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_stoichiometric_imbalance)
    * [`compute_weight_fractions()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.compute_weight_fractions)
    * [`measure_lower_bound_weight_fraction_of_soluble_material()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.measure_lower_bound_weight_fraction_of_soluble_material)
    * [`measure_weight_fraction_of_backbone()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.measure_weight_fraction_of_backbone)
    * [`measure_weight_fraction_of_dangling_chains()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.measure_weight_fraction_of_dangling_chains)
    * [`measure_weight_fraction_of_soluble_material()`](pylimer_tools.calc.html.md#pylimer_tools.calc.structure_analysis.measure_weight_fraction_of_soluble_material)
  * [Module contents](pylimer_tools.calc.html.md#module-pylimer_tools.calc)
* [pylimer_tools.io package](pylimer_tools.io.html.md)
  * [Submodules](pylimer_tools.io.html.md#submodules)
  * [pylimer_tools.io.bead_spring_parameter_provider module](pylimer_tools.io.html.md#module-pylimer_tools.io.bead_spring_parameter_provider)
    * [`ParameterType`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.ParameterType)
      * [`ParameterType.GAUSSIAN`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.ParameterType.GAUSSIAN)
      * [`ParameterType.KG_LJ`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.ParameterType.KG_LJ)
      * [`ParameterType.KUHN`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.ParameterType.KUHN)
      * [`ParameterType.GAUSSIAN`](pylimer_tools.io.html.md#id0)
      * [`ParameterType.KG_LJ`](pylimer_tools.io.html.md#id1)
      * [`ParameterType.KUHN`](pylimer_tools.io.html.md#id2)
    * [`Parameters`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters)
      * [`Parameters.get()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get)
      * [`Parameters.get_base_distance_units()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_base_distance_units)
      * [`Parameters.get_bead_density()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_bead_density)
      * [`Parameters.get_entanglement_density()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_entanglement_density)
      * [`Parameters.get_fb_stress_conversion()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_fb_stress_conversion)
      * [`Parameters.get_gamma_conversion_factor()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_gamma_conversion_factor)
      * [`Parameters.get_kappa()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_kappa)
      * [`Parameters.get_name()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_name)
      * [`Parameters.get_sampling_cutoff()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_sampling_cutoff)
      * [`Parameters.get_unit_registry()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters.get_unit_registry)
    * [`assemble_gaussian_parameters_from_kuhn()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.assemble_gaussian_parameters_from_kuhn)
    * [`get_gaussian_parameters_for_polymer()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.get_gaussian_parameters_for_polymer)
    * [`get_kg_lj_parameters_for_polymer()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.get_kg_lj_parameters_for_polymer)
    * [`get_kuhn_parameters_for_polymer()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.get_kuhn_parameters_for_polymer)
    * [`get_parameters_for_polymer()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.get_parameters_for_polymer)
    * [`get_supported_polymer_names()`](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.get_supported_polymer_names)
  * [pylimer_tools.io.extract_thermo_data module](pylimer_tools.io.html.md#module-pylimer_tools.io.extract_thermo_data)
    * [`detect_headers()`](pylimer_tools.io.html.md#pylimer_tools.io.extract_thermo_data.detect_headers)
    * [`extract_thermo_params()`](pylimer_tools.io.html.md#pylimer_tools.io.extract_thermo_data.extract_thermo_params)
    * [`get_thermo_cache_name_suffix()`](pylimer_tools.io.html.md#pylimer_tools.io.extract_thermo_data.get_thermo_cache_name_suffix)
    * [`read_multi_section_separated_value_file()`](pylimer_tools.io.html.md#pylimer_tools.io.extract_thermo_data.read_multi_section_separated_value_file)
    * [`read_one_group()`](pylimer_tools.io.html.md#pylimer_tools.io.extract_thermo_data.read_one_group)
  * [pylimer_tools.io.polymer_data module](pylimer_tools.io.html.md#module-pylimer_tools.io.polymer_data)
    * [`PolymerData`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerData)
      * [`PolymerData.__getattr__()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerData.__getattr__)
      * [`PolymerData.__getitem__()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerData.__getitem__)
      * [`PolymerData.get()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerData.get)
      * [`PolymerData.to_dict()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerData.to_dict)
    * [`PolymerDataFrame`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame)
      * [`PolymerDataFrame.__getitem__()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.__getitem__)
      * [`PolymerDataFrame.__len__()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.__len__)
      * [`PolymerDataFrame.__repr__()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.__repr__)
      * [`PolymerDataFrame.columns`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.columns)
      * [`PolymerDataFrame.head()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.head)
      * [`PolymerDataFrame.index`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.index)
      * [`PolymerDataFrame.iterrows()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.iterrows)
      * [`PolymerDataFrame.itertuples()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.itertuples)
      * [`PolymerDataFrame.query()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.query)
      * [`PolymerDataFrame.shape`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.shape)
      * [`PolymerDataFrame.tail()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.tail)
      * [`PolymerDataFrame.unique()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.PolymerDataFrame.unique)
    * [`get_available_polymers()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.get_available_polymers)
    * [`get_polymer_by_name()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.get_polymer_by_name)
    * [`load_everaers_et_al_data()`](pylimer_tools.io.html.md#pylimer_tools.io.polymer_data.load_everaers_et_al_data)
  * [pylimer_tools.io.read_pylimer_tools_output_file module](pylimer_tools.io.html.md#module-pylimer_tools.io.read_pylimer_tools_output_file)
    * [`read_avg_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_pylimer_tools_output_file.read_avg_file)
  * [pylimer_tools.io.read_lammps_output_file module](pylimer_tools.io.html.md#module-pylimer_tools.io.read_lammps_output_file)
    * [`read_averages_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_averages_file)
    * [`read_correlation_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_correlation_file)
    * [`read_data_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_data_file)
    * [`read_dump_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_dump_file)
    * [`read_histogram_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_histogram_file)
    * [`read_log_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_log_file)
    * [`read_sectioned_averages_file()`](pylimer_tools.io.html.md#pylimer_tools.io.read_lammps_output_file.read_sectioned_averages_file)
  * [pylimer_tools.io.unit_styles module](pylimer_tools.io.html.md#module-pylimer_tools.io.unit_styles)
    * [`UnitStyle`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyle)
      * [`UnitStyle.__getattr__()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyle.__getattr__)
      * [`UnitStyle.get_base_unit_of()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyle.get_base_unit_of)
      * [`UnitStyle.get_underlying_unit_registry()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyle.get_underlying_unit_registry)
    * [`UnitStyleFactory`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyleFactory)
      * [`UnitStyleFactory.get_available_polymers()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyleFactory.get_available_polymers)
      * [`UnitStyleFactory.get_everares_et_al_data()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyleFactory.get_everares_et_al_data)
      * [`UnitStyleFactory.get_unit_registry()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyleFactory.get_unit_registry)
      * [`UnitStyleFactory.get_unit_style()`](pylimer_tools.io.html.md#pylimer_tools.io.unit_styles.UnitStyleFactory.get_unit_style)
  * [Module contents](pylimer_tools.io.html.md#module-pylimer_tools.io)
* [pylimer_tools.utils package](pylimer_tools.utils.html.md)
  * [Submodules](pylimer_tools.utils.html.md#submodules)
  * [pylimer_tools.utils.cache_utility module](pylimer_tools.utils.html.md#module-pylimer_tools.utils.cache_utility)
    * [`do_cache()`](pylimer_tools.utils.html.md#pylimer_tools.utils.cache_utility.do_cache)
    * [`get_cache_file_name()`](pylimer_tools.utils.html.md#pylimer_tools.utils.cache_utility.get_cache_file_name)
    * [`is_current_cache()`](pylimer_tools.utils.html.md#pylimer_tools.utils.cache_utility.is_current_cache)
    * [`load_cache()`](pylimer_tools.utils.html.md#pylimer_tools.utils.cache_utility.load_cache)
  * [pylimer_tools.utils.data_utility module](pylimer_tools.utils.html.md#module-pylimer_tools.utils.data_utility)
    * [`apply_to_numeric_ignore_compat()`](pylimer_tools.utils.html.md#pylimer_tools.utils.data_utility.apply_to_numeric_ignore_compat)
    * [`get_tail()`](pylimer_tools.utils.html.md#pylimer_tools.utils.data_utility.get_tail)
    * [`unify_data_stepsizes()`](pylimer_tools.utils.html.md#pylimer_tools.utils.data_utility.unify_data_stepsizes)
  * [pylimer_tools.utils.optimize_dataframe module](pylimer_tools.utils.html.md#module-pylimer_tools.utils.optimize_dataframe)
    * [`optimize()`](pylimer_tools.utils.html.md#pylimer_tools.utils.optimize_dataframe.optimize)
    * [`optimize_floats()`](pylimer_tools.utils.html.md#pylimer_tools.utils.optimize_dataframe.optimize_floats)
    * [`optimize_ints()`](pylimer_tools.utils.html.md#pylimer_tools.utils.optimize_dataframe.optimize_ints)
    * [`optimize_objects()`](pylimer_tools.utils.html.md#pylimer_tools.utils.optimize_dataframe.optimize_objects)
    * [`reduce_mem_usage()`](pylimer_tools.utils.html.md#pylimer_tools.utils.optimize_dataframe.reduce_mem_usage)
  * [Module contents](pylimer_tools.utils.html.md#module-pylimer_tools.utils)

## Submodules

## pylimer_tools.analyse_networks module

### Analyse Networks

This script provides a command-line interface (CLI) to analyze polymer networks
generated by LAMMPS simulations. It reads structure files, computes various
properties of the networks, and outputs statistics such as bond lengths,
end-to-end distances, and stoichiometric imbalances.

## pylimer_tools.basic_lammps_structure_stats module

## pylimer_tools.displace_randomly module

## pylimer_tools.generate_network module

### Generate MC Network

Uses an MC procedure to generate a crosslinked polymer network.

### pylimer_tools.generate_network.generate_structure(params: [Parameters](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters), target_p: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, target_wsol: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, n_chains_crosslinkers: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, target_f: [int](https://docs.python.org/3/builtins/functions.html#int) = 4, n_solvent_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_solvent_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 1000, n_beads_per_chain_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_chain_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_beads_per_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_xlink: [int](https://docs.python.org/3/builtins/functions.html#int) = 1, remove_wsol: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, functionalize_discrete: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_primary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_secondary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, z_score_std_mult: [float](https://docs.python.org/3/builtins/functions.html#float) = 3.0) → [Universe](api/pylimer_tools_cpp.Universe.html.md#pylimer_tools_cpp.Universe)

Generate a universe with the given network generation parameter choices.

### pylimer_tools.generate_network.is_active_network(params: [Parameters](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters), target_p: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, target_wsol: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, n_chains_crosslinkers: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, target_f: [int](https://docs.python.org/3/builtins/functions.html#int) = 4, n_solvent_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_solvent_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 1000, n_beads_per_chain_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_chain_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_beads_per_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_xlink: [int](https://docs.python.org/3/builtins/functions.html#int) = 1, remove_wsol: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, functionalize_discrete: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_primary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_secondary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, z_score_std_mult: [float](https://docs.python.org/3/builtins/functions.html#float) = 3.0) → [bool](https://docs.python.org/3/builtins/functions.html#bool)

Check whether the given network generation parameter choices may result in a network that
has a modulus > 0.

### pylimer_tools.generate_network.prepare_structure_generation(params: [Parameters](pylimer_tools.io.html.md#pylimer_tools.io.bead_spring_parameter_provider.Parameters), target_p: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, target_wsol: [float](https://docs.python.org/3/builtins/functions.html#float) | [None](https://docs.python.org/3/builtins/constants.html#None) = None, n_chains_crosslinkers: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, target_f: [int](https://docs.python.org/3/builtins/functions.html#int) = 4, n_solvent_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_solvent_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 1000, n_beads_per_chain_1: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_chains_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_chain_2: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_chains: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_mono_beads_per_chain: [int](https://docs.python.org/3/builtins/functions.html#int) = 0, n_beads_per_xlink: [int](https://docs.python.org/3/builtins/functions.html#int) = 1, remove_wsol: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, functionalize_discrete: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_primary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, disable_secondary_loops: [bool](https://docs.python.org/3/builtins/functions.html#bool) = False, z_score_std_mult: [float](https://docs.python.org/3/builtins/functions.html#float) = 3.0) → [MCUniverseGenerator](api/pylimer_tools_cpp.MCUniverseGenerator.html.md#pylimer_tools_cpp.MCUniverseGenerator)

### pylimer_tools.generate_network.print_with_time(message: [str](https://docs.python.org/3/builtins/stdtypes.html#str)) → [None](https://docs.python.org/3/builtins/constants.html#None)

## Module contents

The pylimer_tools package is the non-compiled part of this library.
While the two packages (pylimer_tools and pylimer_tools_cpp) do interact and don’t work standalone,
this distinction is nonetheless useful for the structure and functionality of the library,
as well as to simplify the compilation process.

In this Python part of the library,
various submodules offer functions that abstract the pylimer_tools_cpp library further,
that builds a bridge to other Python libraries, such as pandas,
or offer functionality that does not need to be as optimized for performance.