From ce044efff908c3e604ac537c4f802e744271733b Mon Sep 17 00:00:00 2001 From: ma-sadeghi Date: Sat, 14 Oct 2023 12:42:56 +0000 Subject: [PATCH] deploy: a7046cf9be584f9de0522045d083386bab1e3527 --- getting_started.html | 26 ++++++++++++++++++- .../generated/beatmap.core.run_beatmap.html | 2 +- searchindex.js | 2 +- 3 files changed, 27 insertions(+), 3 deletions(-) diff --git a/getting_started.html b/getting_started.html index 6ce11aa..3c9cf76 100644 --- a/getting_started.html +++ b/getting_started.html @@ -284,7 +284,31 @@

Automated BET analysisimport matplotlib.pylot as plt fpath = bt.utils.get_fixtures_path() / 'vulcan_chex.csv' -bt.run_beatmap(file=fpath, info='chex on vulcan', a_o=39) + +rouq_criteria = { + "enforce_y_intercept_positive": True, + "enforce_pressure_increasing": True, + "enforce_absorbed_amount": True, + "enforce_relative_pressure": True, + "enforce_enough_datapoints": True, + "min_num_points": 5 +} + +aux_params = { + "save_figures": True, + "export_data": False, + "ssa_gradient": "Greens", + "err_gradient": "Greys" +} + +results = bt.run_beatmap( + file=fpath, + info="chex on vulcan" + a_o=39, + ssa_criterion="error", + **rouq_criteria, + **aux_params +) diff --git a/modules/generated/beatmap.core.run_beatmap.html b/modules/generated/beatmap.core.run_beatmap.html index 4c87131..15a7612 100644 --- a/modules/generated/beatmap.core.run_beatmap.html +++ b/modules/generated/beatmap.core.run_beatmap.html @@ -237,7 +237,7 @@

run_beatmap#

-beatmap.core.run_beatmap(file=None, info=None, a_o=None, enforce_y_intercept_positive=True, enforce_pressure_increasing=True, enforce_absorbed_amount=True, enforce_relative_pressure=True, enforce_enough_datapoints=True, min_num_points=5, save_figures=True, export_data=False, ssa_criterion='error', ssa_gradient='greens', err_gradient='greys')#
+beatmap.core.run_beatmap(file=None, info=None, a_o=None, enforce_y_intercept_positive=True, enforce_pressure_increasing=True, enforce_absorbed_amount=True, enforce_relative_pressure=True, enforce_enough_datapoints=True, min_num_points=5, save_figures=True, export_data=False, ssa_criterion='error', ssa_gradient='Greens', err_gradient='Greys')#

A single function that executes all necessary BEaTmap algorithims.

This function is built to be as user friendly as possible. The file name/path of the isotherm data, information about the isotherm, and the diff --git a/searchindex.js b/searchindex.js index c972628..69ee21d 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["getting_started", "index", "modules/generated/beatmap.core", "modules/generated/beatmap.core.bet", "modules/generated/beatmap.core.check_absorbed_amount", "modules/generated/beatmap.core.check_enough_datapoints", "modules/generated/beatmap.core.check_pressure_consistency", "modules/generated/beatmap.core.check_pressure_increasing", "modules/generated/beatmap.core.check_y_intercept_positive", "modules/generated/beatmap.core.rouq_mask", "modules/generated/beatmap.core.run_beatmap", "modules/generated/beatmap.core.single_point_bet", "modules/generated/beatmap.core.ssa_answer", "modules/generated/beatmap.io", "modules/generated/beatmap.io.export_processed_data", "modules/generated/beatmap.io.export_raw_data", "modules/generated/beatmap.io.import_data", "modules/generated/beatmap.io.import_list_data", "modules/generated/beatmap.utils", "modules/generated/beatmap.utils.find_package_root", "modules/generated/beatmap.utils.get_fixtures_path", "modules/generated/beatmap.utils.get_logger", "modules/generated/beatmap.utils.index_of_value", "modules/generated/beatmap.utils.lin_interp", "modules/generated/beatmap.utils.max_min", "modules/generated/beatmap.vis", "modules/generated/beatmap.vis.ascii_tables", "modules/generated/beatmap.vis.bet_combo_plot", "modules/generated/beatmap.vis.dataframe_tables", "modules/generated/beatmap.vis.err_heatmap", "modules/generated/beatmap.vis.experimental_data_plot", "modules/generated/beatmap.vis.iso_combo_plot", "modules/generated/beatmap.vis.ssa_heatmap", "modules/index"], "filenames": ["getting_started.rst", "index.rst", "modules/generated/beatmap.core.rst", "modules/generated/beatmap.core.bet.rst", "modules/generated/beatmap.core.check_absorbed_amount.rst", "modules/generated/beatmap.core.check_enough_datapoints.rst", "modules/generated/beatmap.core.check_pressure_consistency.rst", "modules/generated/beatmap.core.check_pressure_increasing.rst", "modules/generated/beatmap.core.check_y_intercept_positive.rst", "modules/generated/beatmap.core.rouq_mask.rst", "modules/generated/beatmap.core.run_beatmap.rst", "modules/generated/beatmap.core.single_point_bet.rst", "modules/generated/beatmap.core.ssa_answer.rst", "modules/generated/beatmap.io.rst", "modules/generated/beatmap.io.export_processed_data.rst", "modules/generated/beatmap.io.export_raw_data.rst", "modules/generated/beatmap.io.import_data.rst", "modules/generated/beatmap.io.import_list_data.rst", "modules/generated/beatmap.utils.rst", "modules/generated/beatmap.utils.find_package_root.rst", "modules/generated/beatmap.utils.get_fixtures_path.rst", "modules/generated/beatmap.utils.get_logger.rst", "modules/generated/beatmap.utils.index_of_value.rst", "modules/generated/beatmap.utils.lin_interp.rst", "modules/generated/beatmap.utils.max_min.rst", "modules/generated/beatmap.vis.rst", "modules/generated/beatmap.vis.ascii_tables.rst", "modules/generated/beatmap.vis.bet_combo_plot.rst", "modules/generated/beatmap.vis.dataframe_tables.rst", "modules/generated/beatmap.vis.err_heatmap.rst", "modules/generated/beatmap.vis.experimental_data_plot.rst", "modules/generated/beatmap.vis.iso_combo_plot.rst", "modules/generated/beatmap.vis.ssa_heatmap.rst", "modules/index.rst"], "titles": ["Getting Started", "BEaTmap: BET Analysis Tool", "core", "bet", "check_absorbed_amount", "check_enough_datapoints", "check_pressure_consistency", "check_pressure_increasing", "check_y_intercept_positive", "rouq_mask", "run_beatmap", "single_point_bet", "ssa_answer", "io", "export_processed_data", "export_raw_data", "import_data", "import_list_data", "utils", "find_package_root", "get_fixtures_path", "get_logger", "index_of_value", "lin_interp", "max_min", "vis", "ascii_tables", "bet_combo_plot", "dataframe_tables", "err_heatmap", "experimental_data_plot", "iso_combo_plot", "ssa_heatmap", "API Reference"], "terms": {"obtain": [0, 1], "surfac": [0, 1, 3, 10, 11, 12, 26, 28, 32], "area": [0, 1, 3, 10, 11, 12, 16, 17, 26, 28, 32], "porou": [0, 1], "sampl": [0, 1], "from": [0, 1, 6, 12, 16, 26, 28], "interpret": [0, 1], "ga": [0, 1], "adsorpt": [0, 1, 4, 5, 6, 7], "isotherm": [0, 1, 3, 4, 5, 6, 7, 9, 10, 11, 14, 15, 16, 17, 26, 27, 28, 29, 30, 31, 33], "veri": [0, 1], "wide": [0, 1], "done": [0, 1], "us": [0, 1, 3, 4, 9, 10, 11, 12, 15, 16, 18, 27, 29, 30, 31, 32], "theori": [0, 1], "develop": [0, 1], "brunauer": [0, 1], "emmett": [0, 1], "teller": [0, 1], "1950": [0, 1], "The": [0, 1, 6, 9, 10, 14, 16, 23, 27, 29, 30, 31, 32], "beat": [0, 1], "so": [0, 1, 27, 29, 31, 32], "commonli": [0, 1], "place": [0, 1], "acronym": [0, 1], "ha": [0, 1], "synonym": [0, 1], "wa": [0, 1], "deriv": [0, 1], "sever": [0, 1], "assumpt": [0, 1], "must": [0, 1, 6, 10, 29, 32], "met": [0, 1], "predict": [0, 1], "valid": [0, 1, 5, 9, 10, 12, 14, 26, 27, 28, 29, 31, 32, 33], "et": [0, 1], "al": [0, 1], "have": [0, 1], "put": [0, 1], "forth": [0, 1], "evalu": [0, 1, 9], "whether": [0, 1], "adsoprt": [0, 1, 14, 15, 16, 17], "data": [0, 1, 3, 4, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17, 23, 25, 26, 27, 28, 29, 30, 31], "meet": [0, 1], "appli": [0, 1, 6, 10, 26, 28], "all": [0, 1, 3, 9, 10, 11, 14, 15, 16, 17, 24, 26, 28], "rel": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 30, 31], "pressur": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 23, 30, 31], "rang": [0, 1, 3, 4, 5, 6, 7, 8, 10, 11, 12, 26, 28, 31, 33], "an": [0, 1, 11, 22, 24, 31], "allow": [0, 1], "one": [0, 1, 9, 17], "elimin": [0, 1], "do": [0, 1, 6], "adher": [0, 1], "visual": [0, 1, 25], "heatmap": [0, 1, 10, 29, 32], "where": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 26, 27, 28, 30, 31], "invalid": [0, 1, 9, 10, 26, 28], "ar": [0, 1, 3, 6, 9, 10, 11, 15, 16, 17, 24, 26, 27, 28, 29, 31, 32], "mask": [0, 1, 9, 12, 26, 27, 28, 29, 31, 32], "provid": [0, 1, 10, 17], "quick": [0, 1], "comprehens": [0, 1], "represent": [0, 1], "conceptul": [0, 1], "vizual": [0, 1], "tool": [0, 33], "util": [0, 1, 19, 20, 21, 22, 23, 24], "consist": [0, 6, 7, 33], "follow": 0, "modul": [0, 33], "core": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "function": [0, 2, 3, 9, 10, 13, 18, 25], "perform": [0, 2, 3, 11], "critieria": 0, "singl": [0, 10, 11, 12], "specif": [0, 3, 4, 6, 10, 11, 12, 16, 23, 26, 28, 30, 32], "answer": [0, 10, 12, 32], "io": [0, 14, 15, 16, 17], "csv": [0, 10, 14, 15, 16], "file": [0, 3, 10, 14, 15, 16, 17], "list": [0, 17], "process": [0, 14], "xlsx": 0, "variou": 0, "small": 0, "other": [0, 3, 17], "vi": [0, 26, 27, 28, 29, 30, 31, 32], "creat": [0, 10, 26, 27, 28, 29, 30, 31, 32], "plot": [0, 3, 8, 27, 30, 31], "tabl": [0, 16, 26], "etc": 0, "we": 0, "web": 0, "base": 0, "gui": 0, "streamlit": 0, "thi": [0, 3, 4, 6, 7, 8, 9, 10, 11], "app": 0, "host": 0, "server": 0, "avail": 0, "here": 0, "If": [0, 9, 10, 24], "certain": 0, "period": 0, "hibern": 0, "wake": 0, "up": 0, "request": 0, "mai": 0, "take": 0, "few": 0, "moment": 0, "load": [0, 31], "includ": [0, 4], "link": 0, "some": [0, 23], "which": [0, 10], "you": [0, 22], "can": [0, 3, 9, 10, 11], "explor": 0, "interfac": 0, "enjoi": 0, "depend": 0, "heavili": 0, "scipi": 0, "stack": 0, "best": [0, 27], "wai": 0, "fulli": 0, "environ": 0, "anaconda": 0, "distribut": 0, "Be": 0, "sure": 0, "python": 0, "3": [0, 3], "9": [0, 3], "version": 0, "onc": 0, "ve": 0, "conda": 0, "packag": [0, 10, 29, 32], "index": [0, 3, 22, 24], "type": 0, "prompt": [0, 10], "pip": 0, "On": 0, "window": 0, "should": 0, "shortcut": 0, "menu": 0, "open": 0, "command": 0, "consol": [0, 10], "access": 0, "featur": 0, "ad": 0, "thing": 0, "via": 0, "mac": 0, "linux": 0, "need": 0, "normal": [0, 29, 32], "termin": 0, "sourc": 0, "activ": 0, "env": 0, "replac": 0, "name": [0, 3, 9, 10, 11, 12, 16, 17, 21, 29, 31, 32], "want": 0, "don": 0, "t": [0, 7], "know": 0, "mean": 0, "default": [0, 5, 10, 12, 14, 29], "think": 0, "interest": 0, "contribut": 0, "wish": [0, 22], "both": 0, "edit": 0, "code": 0, "clone": 0, "repositori": 0, "your": 0, "local": 0, "machin": 0, "e": 0, "path": [0, 10, 16, 17, 20], "root": 0, "folder": 0, "For": [0, 22, 24], "inform": [0, 3, 10, 11, 14, 15, 16, 17], "about": [0, 10], "refer": [0, 1], "contributor": 0, "guid": 0, "snippet": 0, "illustr": 0, "how": 0, "produc": 0, "figur": [0, 10, 27, 29, 30, 31, 32], "repo": 0, "brows": 0, "envelop": 0, "user": [0, 10, 12, 17], "been": 0, "built": [0, 10], "later": [0, 10], "adsorb": [0, 3, 4, 6, 10, 11, 15, 16, 17, 23, 30], "cross": [0, 3, 10, 11, 16, 17], "section": [0, 3, 10, 11, 16, 17], "squar": [0, 3, 10, 11, 16], "angstrom": [0, 3, 10, 11, 16], "specifi": [0, 10, 12], "much": 0, "": [0, 8], "line": [0, 27], "bt": 0, "matplotlib": [0, 27, 31], "pylot": 0, "plt": 0, "fpath": 0, "get_fixtures_path": 0, "vulcan_chex": 0, "run_beatmap": 0, "info": [0, 3, 10, 15, 16, 17], "chex": 0, "vulcan": 0, "a_o": [0, 3, 10, 11, 16, 17], "39": 0, "altern": 0, "individu": [0, 3, 9], "more": [0, 10], "custom": 0, "import_data": 0, "first": [0, 3, 11, 16], "column": [0, 16], "second": [0, 6, 16], "amount": [0, 3, 4, 6, 9, 10, 11, 16, 17, 23, 30], "return": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 20, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32], "tupl": [0, 3, 9, 11, 12, 31], "entri": 0, "datafram": [0, 3, 4, 5, 6, 7, 9, 11, 15, 16, 17, 23, 26, 28], "2nd": 0, "4th": [0, 3], "field": [0, 9, 11, 15, 16, 17, 26, 28], "respect": [0, 10], "element": [0, 3, 26, 27, 28, 29, 30, 31, 32], "order": [0, 3], "prioriti": [0, 3], "given": [0, 3, 21], "isotherm_data": [0, 3, 15, 16, 17, 30], "everi": 0, "within": [0, 6], "accept": [0, 3, 9], "store": [0, 3, 11], "rather": [0, 3, 9], "than": [0, 3, 5, 9, 10], "pass": [0, 3, 6, 9, 10, 22], "paramet": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32], "output": [0, 3, 9, 10], "contain": [0, 2, 3, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 23, 25, 26, 27, 28, 31], "well": 0, "raw": [0, 15, 23], "again": 0, "bet_result": [0, 3, 9, 11, 12, 14, 15, 26, 27, 28, 29, 31, 32], "iso_df": [0, 3, 9, 15, 26, 27, 28, 30, 31], "out": 0, "rouq_mask": [0, 12], "numpi": 0, "arrai": [0, 3, 4, 5, 6, 7, 8, 9, 11, 12, 22, 24], "correspond": [0, 3, 4, 5, 6, 7, 8, 9, 11, 12, 23, 29, 32], "each": [0, 9], "criterion": [0, 10, 12], "mask_result": [0, 12, 26, 27, 28, 29, 31, 32], "intercept": [0, 3, 6, 8, 9, 10], "nm": [0, 3, 4, 6, 9, 11, 31], "slope": [0, 3, 6, 9], "enforce_y_intercept_posit": [0, 9, 10], "true": [0, 9, 10, 27, 29, 30, 31, 32], "enforce_pressure_increas": [0, 9, 10], "enforce_absorbed_amount": [0, 9, 10], "enforce_relative_pressur": [0, 9, 10], "enforce_enough_datapoint": [0, 9, 10], "min_num_point": [0, 9, 10, 14], "5": [0, 5, 9, 10, 14], "valu": [0, 3, 4, 5, 6, 8, 9, 10, 11, 12, 17, 22, 23, 24, 26, 27, 28, 29, 32], "concept": 0, "central": 0, "idea": 0, "ssa_heatmap": 0, "requir": [0, 5, 11, 14, 15, 16, 17], "experiment": [0, 3, 4, 5, 6, 7, 9, 11, 14, 17, 26, 28, 29, 30], "model": 0, "manner": 0, "see": 0, "document": 0, "full": 0, "summari": [0, 26, 28], "iso_combo_plot": 0, "save_fil": [0, 27, 29, 30, 31, 32], "might": 0, "desir": 0, "spreadsheet": 0, "sheet": 0, "save": [0, 10, 14, 15], "parent": [0, 10, 14, 15], "directori": [0, 10, 14, 15, 20, 27, 29, 30, 31, 32], "export_processed_data": 0, "rouquerol": [1, 26, 28], "criteria": [1, 10, 12, 26, 28], "result": [1, 3, 6, 9, 10, 11, 25, 26, 27, 28, 29, 31, 32], "get": [1, 21], "start": [1, 3], "api": 1, "bet": [2, 4, 5, 6, 7, 8, 9, 11, 14, 15, 16, 17, 26, 27, 28, 29, 31, 33], "analysi": [2, 3, 4, 5, 11, 14, 15, 16, 17, 26, 28], "beatmap": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32, 33], "arg": [3, 9], "ani": [3, 10], "i": [3, 4, 5, 6, 7, 8, 9, 10, 14, 15, 16, 22, 24, 27, 29, 30, 31, 32, 33], "less": [3, 5], "end": 3, "written": [3, 15], "eg": [3, 10], "indici": [3, 11], "begin": 3, "point": [3, 4, 5, 9, 10, 11, 12, 14, 23, 31], "10th": 3, "import": [3, 4, 5, 6, 7, 16, 17], "float": [3, 10, 12, 16, 17, 23, 24, 26, 28], "str": [3, 10, 12, 15, 16, 17, 19, 21, 32], "namedtupl": [3, 9, 11, 14, 15, 16, 17, 26, 27, 28, 29, 30, 32], "ndarrai": [3, 4, 5, 6, 7, 8, 9, 11, 26, 28], "2d": [3, 4, 6, 8, 9, 11, 22, 24], "trendlin": 3, "last": [3, 11], "datapoint": [3, 10, 11, 27], "monolay": [3, 4, 6, 9, 10, 11, 31], "mol": [3, 11, 16, 17], "g": [3, 11, 16, 17], "ssa": [3, 10, 11, 12, 26, 28, 32], "m": [3, 11], "2": [3, 10, 11], "c": [3, 26, 28], "constant": [3, 26, 28], "err": [3, 26, 28, 29], "averag": [3, 26, 28, 29], "error": [3, 10, 12, 26, 27, 28, 29, 31], "between": [3, 10, 11, 23, 29], "theoret": [3, 10, 29], "r": 3, "num_pt": 3, "number": [3, 5, 9, 10, 12, 14], "per": [3, 10, 17], "string": [3, 16, 17, 29], "df": [4, 5, 6, 7, 11, 23], "check": [4, 5, 6, 7, 8, 9, 11], "coordin": [4, 6], "unit": [4, 6, 17], "mole": [4, 6], "gram": [4, 6, 17], "1": [4, 5, 6, 7, 8, 9, 22, 24, 31], "0": [4, 5, 6, 7, 8, 9, 22, 24, 29], "n": [4, 6, 7, 10, 16, 17, 23, 31], "ie": [4, 6, 7, 8], "fail": [4, 6, 7, 8, 9], "minimum": [5, 9, 10, 12, 14, 24, 27, 31, 32], "int": [5, 9, 10, 14], "consid": [5, 9, 10, 14], "found": 6, "linear": [6, 7, 8], "interpol": [6, 23], "experiement": 6, "A": [6, 10], "set": [6, 10, 11, 27], "equat": [6, 27], "solv": 6, "two": [6, 16, 17, 23], "compar": 6, "agre": 6, "10": [6, 10], "regress": [6, 8], "relev": [6, 11, 15, 16, 17, 26, 28], "y": [6, 8, 10, 30], "p": [7, 10, 33], "po": [7, 10], "aka": 7, "check2": [7, 9, 10], "increas": 7, "necessari": [7, 10], "condit": 7, "dataset": 7, "isn": 7, "posit": 8, "neg": [8, 10], "zero": 8, "call": 9, "combin": 9, "rouqerol": 9, "check1": [9, 10], "check3": [9, 10], "check4": [9, 10], "bool": [9, 10, 27, 32], "otherwis": 9, "skip": 9, "enforce_absorbed_amount_valid": 9, "enforce_relative_pressure_valid": 9, "interv": [9, 14], "select": [9, 10], "maskedarrai": [9, 26, 28], "object": [9, 26, 27, 28, 31], "check5": [9, 10], "none": [10, 14, 15, 16, 17, 29, 30, 32], "save_figur": 10, "export_data": 10, "fals": [10, 30], "ssa_criterion": 10, "ssa_gradi": 10, "green": [10, 32], "err_gradi": 10, "grei": [10, 29], "execut": 10, "algorithim": 10, "friendli": 10, "possibl": 10, "Or": 10, "left": 10, "empti": 10, "input": 10, "them": 10, "myfil": 10, "nitrogen": 10, "carbon": 10, "16": 10, "In": 10, "case": 10, "former": 10, "through": 10, "promt": 10, "addit": 10, "roquerol": 10, "defin": [10, 12], "reason": 10, "decreas": 10, "fall": 10, "outsid": 10, "disagr": 10, "actual": 10, "coverag": 10, "occur": [10, 31], "fewer": 10, "png": [10, 27, 29, 30, 31, 32], "export": [10, 14, 15], "lowest": [10, 12], "most": [10, 12, 22], "color": [10, 29, 32], "gradient": [10, 29, 32], "vaild": [10, 29, 32], "seaborn": [10, 29, 32], "agreement": 11, "also": 11, "raw_data": 11, "flaot": 11, "molecul": [11, 16], "singlept_result": 11, "log": 12, "maximum": [12, 24, 27, 29, 32], "remov": 12, "invaid": 12, "consider": 12, "final": 12, "either": 12, "max": [12, 24], "min": [12, 24], "ssa_an": 12, "read": 13, "write": 13, "format": [16, 26], "expect": 16, "being": 16, "buffer": 16, "short": 16, "descript": 16, "identifi": 16, "iso_data": [16, 17], "relp": [17, 23, 26, 28], "helper": 18, "throughout": 18, "librari": 18, "package_nam": 19, "fixtur": 20, "logger": 21, "find": [22, 23, 24], "similar": 22, "numer": 22, "idx": 22, "j": [22, 24], "val": 23, "linerarli": 23, "design": 23, "realtaiv": 23, "interp_v": 23, "multipl": 24, "exist": 24, "max_idx": 24, "min_idx": 24, "print": 26, "ascii": 26, "prettyt": 26, "highlight": [26, 28], "high": [26, 28], "low": [26, 28], "table2": 26, "ssa_std": [26, 28], "atandard": [26, 28], "deviat": [26, 28], "c_std": [26, 28], "standard": [26, 28], "maxium": 27, "onli": [27, 29, 31, 32], "fit": 27, "r2": 27, "annot": 27, "displai": [27, 29, 31, 32], "when": [27, 29, 30, 31, 32], "work": [27, 29, 30, 31, 32], "ax": [27, 31], "popul": 28, "panda": 28, "summar": 28, "ssa_tabl": 28, "c_tabl": 28, "shade": [29, 32], "white": 29, "black": 29, "boolean": [29, 30, 31], "scatter": 30, "typic": 30, "present": 30, "x": 30, "axi": 30, "imag": 31, "same": 31, "sa": 32, "four": 33, "main": 33, "determin": 33, "p0": 33}, "objects": {"": [[33, 0, 0, "-", "beatmap"]], "beatmap": [[2, 0, 0, "-", "core"], [13, 0, 0, "-", "io"], [18, 0, 0, "-", "utils"], [25, 0, 0, "-", "vis"]], "beatmap.core": [[3, 1, 1, "", "bet"], [4, 1, 1, "", "check_absorbed_amount"], [5, 1, 1, "", "check_enough_datapoints"], [6, 1, 1, "", "check_pressure_consistency"], [7, 1, 1, "", "check_pressure_increasing"], [8, 1, 1, "", "check_y_intercept_positive"], [9, 1, 1, "", "rouq_mask"], [10, 1, 1, "", "run_beatmap"], [11, 1, 1, "", "single_point_bet"], [12, 1, 1, "", "ssa_answer"]], "beatmap.io": [[14, 1, 1, "", "export_processed_data"], [15, 1, 1, "", "export_raw_data"], [16, 1, 1, "", "import_data"], [17, 1, 1, "", "import_list_data"]], "beatmap.utils": [[19, 1, 1, "", "find_package_root"], [20, 1, 1, "", "get_fixtures_path"], [21, 1, 1, "", "get_logger"], [22, 1, 1, "", "index_of_value"], [23, 1, 1, "", "lin_interp"], [24, 1, 1, "", "max_min"]], "beatmap.vis": [[26, 1, 1, "", "ascii_tables"], [27, 1, 1, "", "bet_combo_plot"], [28, 1, 1, "", "dataframe_tables"], [29, 1, 1, "", "err_heatmap"], [30, 1, 1, "", "experimental_data_plot"], [31, 1, 1, "", "iso_combo_plot"], [32, 1, 1, "", "ssa_heatmap"]]}, "objtypes": {"0": "py:module", "1": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "titleterms": {"get": 0, "start": 0, "what": [0, 1], "i": [0, 1], "beatmap": [0, 1], "capabl": 0, "try": 0, "It": 0, "live": 0, "instal": 0, "exampl": 0, "autom": 0, "bet": [0, 1, 3], "analysi": [0, 1], "manual": 0, "import": 0, "dataset": 0, "rouquerol": 0, "criteria": 0, "supplementari": 0, "export": 0, "result": 0, "tool": 1, "content": [1, 33], "core": 2, "check_absorbed_amount": 4, "check_enough_datapoint": 5, "check_pressure_consist": 6, "check_pressure_increas": 7, "check_y_intercept_posit": 8, "rouq_mask": 9, "run_beatmap": 10, "single_point_bet": 11, "ssa_answ": 12, "io": 13, "export_processed_data": 14, "export_raw_data": 15, "import_data": 16, "import_list_data": 17, "util": 18, "find_package_root": 19, "get_fixtures_path": 20, "get_logg": 21, "index_of_valu": 22, "lin_interp": 23, "max_min": 24, "vi": 25, "ascii_t": 26, "bet_combo_plot": 27, "dataframe_t": 28, "err_heatmap": 29, "experimental_data_plot": 30, "iso_combo_plot": 31, "ssa_heatmap": 32, "api": 33, "refer": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Getting Started": [[0, "getting-started"]], "What is BEaTmap?": [[0, "what-is-beatmap"], [1, "what-is-beatmap"]], "Capabilities": [[0, "capabilities"]], "Try It Live": [[0, "try-it-live"]], "Installation": [[0, "installation"]], "Examples": [[0, "examples"]], "Automated BET analysis": [[0, "automated-bet-analysis"]], "Manual BET analysis": [[0, "manual-bet-analysis"]], "Import the dataset": [[0, "import-the-dataset"]], "BET analysis": [[0, "bet-analysis"]], "Rouquerol criteria": [[0, "rouquerol-criteria"]], "Supplementary analysis": [[0, "supplementary-analysis"]], "Export the results": [[0, "export-the-results"]], "BEaTmap: BET Analysis Tool": [[1, "beatmap-bet-analysis-tool"]], "Contents": [[1, "contents"], [33, "module-beatmap"]], "core": [[2, "module-beatmap.core"], [2, "id1"]], "bet": [[3, "bet"]], "check_absorbed_amount": [[4, "check-absorbed-amount"]], "check_enough_datapoints": [[5, "check-enough-datapoints"]], "check_pressure_consistency": [[6, "check-pressure-consistency"]], "check_pressure_increasing": [[7, "check-pressure-increasing"]], "check_y_intercept_positive": [[8, "check-y-intercept-positive"]], "rouq_mask": [[9, "rouq-mask"]], "run_beatmap": [[10, "run-beatmap"]], "single_point_bet": [[11, "single-point-bet"]], "ssa_answer": [[12, "ssa-answer"]], "io": [[13, "module-beatmap.io"], [13, "id1"]], "export_processed_data": [[14, "export-processed-data"]], "export_raw_data": [[15, "export-raw-data"]], "import_data": [[16, "import-data"]], "import_list_data": [[17, "import-list-data"]], "utils": [[18, "module-beatmap.utils"], [18, "id1"]], "find_package_root": [[19, "find-package-root"]], "get_fixtures_path": [[20, "get-fixtures-path"]], "get_logger": [[21, "get-logger"]], "index_of_value": [[22, "index-of-value"]], "lin_interp": [[23, "lin-interp"]], "max_min": [[24, "max-min"]], "vis": [[25, "module-beatmap.vis"], [25, "id1"]], "ascii_tables": [[26, "ascii-tables"]], "bet_combo_plot": [[27, "bet-combo-plot"]], "dataframe_tables": [[28, "dataframe-tables"]], "err_heatmap": [[29, "err-heatmap"]], "experimental_data_plot": [[30, "experimental-data-plot"]], "iso_combo_plot": [[31, "iso-combo-plot"]], "ssa_heatmap": [[32, "ssa-heatmap"]], "API Reference": [[33, "api-reference"]]}, "indexentries": {"beatmap.core": [[2, "module-beatmap.core"]], "module": [[2, "module-beatmap.core"], [13, "module-beatmap.io"], [18, "module-beatmap.utils"], [25, "module-beatmap.vis"], [33, "module-beatmap"]], "bet() (in module beatmap.core)": [[3, "beatmap.core.bet"]], "check_absorbed_amount() (in module beatmap.core)": [[4, "beatmap.core.check_absorbed_amount"]], "check_enough_datapoints() (in module beatmap.core)": [[5, "beatmap.core.check_enough_datapoints"]], "check_pressure_consistency() (in module beatmap.core)": [[6, "beatmap.core.check_pressure_consistency"]], "check_pressure_increasing() (in module beatmap.core)": [[7, "beatmap.core.check_pressure_increasing"]], "check_y_intercept_positive() (in module beatmap.core)": [[8, "beatmap.core.check_y_intercept_positive"]], "rouq_mask() (in module beatmap.core)": [[9, "beatmap.core.rouq_mask"]], "run_beatmap() (in module beatmap.core)": [[10, "beatmap.core.run_beatmap"]], "single_point_bet() (in module beatmap.core)": [[11, "beatmap.core.single_point_bet"]], "ssa_answer() (in module beatmap.core)": [[12, "beatmap.core.ssa_answer"]], "beatmap.io": [[13, "module-beatmap.io"]], "export_processed_data() (in module beatmap.io)": [[14, "beatmap.io.export_processed_data"]], "export_raw_data() (in module beatmap.io)": [[15, "beatmap.io.export_raw_data"]], "import_data() (in module beatmap.io)": [[16, "beatmap.io.import_data"]], "import_list_data() (in module beatmap.io)": [[17, "beatmap.io.import_list_data"]], "beatmap.utils": [[18, "module-beatmap.utils"]], "find_package_root() (in module beatmap.utils)": [[19, "beatmap.utils.find_package_root"]], "get_fixtures_path() (in module beatmap.utils)": [[20, "beatmap.utils.get_fixtures_path"]], "get_logger() (in module beatmap.utils)": [[21, "beatmap.utils.get_logger"]], "index_of_value() (in module beatmap.utils)": [[22, "beatmap.utils.index_of_value"]], "lin_interp() (in module beatmap.utils)": [[23, "beatmap.utils.lin_interp"]], "max_min() (in module beatmap.utils)": [[24, "beatmap.utils.max_min"]], "beatmap.vis": [[25, "module-beatmap.vis"]], "ascii_tables() (in module beatmap.vis)": [[26, "beatmap.vis.ascii_tables"]], "bet_combo_plot() (in module beatmap.vis)": [[27, "beatmap.vis.bet_combo_plot"]], "dataframe_tables() (in module beatmap.vis)": [[28, "beatmap.vis.dataframe_tables"]], "err_heatmap() (in module beatmap.vis)": [[29, "beatmap.vis.err_heatmap"]], "experimental_data_plot() (in module beatmap.vis)": [[30, "beatmap.vis.experimental_data_plot"]], "iso_combo_plot() (in module beatmap.vis)": [[31, "beatmap.vis.iso_combo_plot"]], "ssa_heatmap() (in module beatmap.vis)": [[32, "beatmap.vis.ssa_heatmap"]], "beatmap": [[33, "module-beatmap"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["getting_started", "index", "modules/generated/beatmap.core", "modules/generated/beatmap.core.bet", "modules/generated/beatmap.core.check_absorbed_amount", "modules/generated/beatmap.core.check_enough_datapoints", "modules/generated/beatmap.core.check_pressure_consistency", "modules/generated/beatmap.core.check_pressure_increasing", "modules/generated/beatmap.core.check_y_intercept_positive", "modules/generated/beatmap.core.rouq_mask", "modules/generated/beatmap.core.run_beatmap", "modules/generated/beatmap.core.single_point_bet", "modules/generated/beatmap.core.ssa_answer", "modules/generated/beatmap.io", "modules/generated/beatmap.io.export_processed_data", "modules/generated/beatmap.io.export_raw_data", "modules/generated/beatmap.io.import_data", "modules/generated/beatmap.io.import_list_data", "modules/generated/beatmap.utils", "modules/generated/beatmap.utils.find_package_root", "modules/generated/beatmap.utils.get_fixtures_path", "modules/generated/beatmap.utils.get_logger", "modules/generated/beatmap.utils.index_of_value", "modules/generated/beatmap.utils.lin_interp", "modules/generated/beatmap.utils.max_min", "modules/generated/beatmap.vis", "modules/generated/beatmap.vis.ascii_tables", "modules/generated/beatmap.vis.bet_combo_plot", "modules/generated/beatmap.vis.dataframe_tables", "modules/generated/beatmap.vis.err_heatmap", "modules/generated/beatmap.vis.experimental_data_plot", "modules/generated/beatmap.vis.iso_combo_plot", "modules/generated/beatmap.vis.ssa_heatmap", "modules/index"], "filenames": ["getting_started.rst", "index.rst", "modules/generated/beatmap.core.rst", "modules/generated/beatmap.core.bet.rst", "modules/generated/beatmap.core.check_absorbed_amount.rst", "modules/generated/beatmap.core.check_enough_datapoints.rst", "modules/generated/beatmap.core.check_pressure_consistency.rst", "modules/generated/beatmap.core.check_pressure_increasing.rst", "modules/generated/beatmap.core.check_y_intercept_positive.rst", "modules/generated/beatmap.core.rouq_mask.rst", "modules/generated/beatmap.core.run_beatmap.rst", "modules/generated/beatmap.core.single_point_bet.rst", "modules/generated/beatmap.core.ssa_answer.rst", "modules/generated/beatmap.io.rst", "modules/generated/beatmap.io.export_processed_data.rst", "modules/generated/beatmap.io.export_raw_data.rst", "modules/generated/beatmap.io.import_data.rst", "modules/generated/beatmap.io.import_list_data.rst", "modules/generated/beatmap.utils.rst", "modules/generated/beatmap.utils.find_package_root.rst", "modules/generated/beatmap.utils.get_fixtures_path.rst", "modules/generated/beatmap.utils.get_logger.rst", "modules/generated/beatmap.utils.index_of_value.rst", "modules/generated/beatmap.utils.lin_interp.rst", "modules/generated/beatmap.utils.max_min.rst", "modules/generated/beatmap.vis.rst", "modules/generated/beatmap.vis.ascii_tables.rst", "modules/generated/beatmap.vis.bet_combo_plot.rst", "modules/generated/beatmap.vis.dataframe_tables.rst", "modules/generated/beatmap.vis.err_heatmap.rst", "modules/generated/beatmap.vis.experimental_data_plot.rst", "modules/generated/beatmap.vis.iso_combo_plot.rst", "modules/generated/beatmap.vis.ssa_heatmap.rst", "modules/index.rst"], "titles": ["Getting Started", "BEaTmap: BET Analysis Tool", "core", "bet", "check_absorbed_amount", "check_enough_datapoints", "check_pressure_consistency", "check_pressure_increasing", "check_y_intercept_positive", "rouq_mask", "run_beatmap", "single_point_bet", "ssa_answer", "io", "export_processed_data", "export_raw_data", "import_data", "import_list_data", "utils", "find_package_root", "get_fixtures_path", "get_logger", "index_of_value", "lin_interp", "max_min", "vis", "ascii_tables", "bet_combo_plot", "dataframe_tables", "err_heatmap", "experimental_data_plot", "iso_combo_plot", "ssa_heatmap", "API Reference"], "terms": {"obtain": [0, 1], "surfac": [0, 1, 3, 10, 11, 12, 26, 28, 32], "area": [0, 1, 3, 10, 11, 12, 16, 17, 26, 28, 32], "porou": [0, 1], "sampl": [0, 1], "from": [0, 1, 6, 12, 16, 26, 28], "interpret": [0, 1], "ga": [0, 1], "adsorpt": [0, 1, 4, 5, 6, 7], "isotherm": [0, 1, 3, 4, 5, 6, 7, 9, 10, 11, 14, 15, 16, 17, 26, 27, 28, 29, 30, 31, 33], "veri": [0, 1], "wide": [0, 1], "done": [0, 1], "us": [0, 1, 3, 4, 9, 10, 11, 12, 15, 16, 18, 27, 29, 30, 31, 32], "theori": [0, 1], "develop": [0, 1], "brunauer": [0, 1], "emmett": [0, 1], "teller": [0, 1], "1950": [0, 1], "The": [0, 1, 6, 9, 10, 14, 16, 23, 27, 29, 30, 31, 32], "beat": [0, 1], "so": [0, 1, 27, 29, 31, 32], "commonli": [0, 1], "place": [0, 1], "acronym": [0, 1], "ha": [0, 1], "synonym": [0, 1], "wa": [0, 1], "deriv": [0, 1], "sever": [0, 1], "assumpt": [0, 1], "must": [0, 1, 6, 10, 29, 32], "met": [0, 1], "predict": [0, 1], "valid": [0, 1, 5, 9, 10, 12, 14, 26, 27, 28, 29, 31, 32, 33], "et": [0, 1], "al": [0, 1], "have": [0, 1], "put": [0, 1], "forth": [0, 1], "evalu": [0, 1, 9], "whether": [0, 1], "adsoprt": [0, 1, 14, 15, 16, 17], "data": [0, 1, 3, 4, 5, 6, 7, 9, 10, 11, 13, 14, 15, 16, 17, 23, 25, 26, 27, 28, 29, 30, 31], "meet": [0, 1], "appli": [0, 1, 6, 10, 26, 28], "all": [0, 1, 3, 9, 10, 11, 14, 15, 16, 17, 24, 26, 28], "rel": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 30, 31], "pressur": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 16, 17, 23, 30, 31], "rang": [0, 1, 3, 4, 5, 6, 7, 8, 10, 11, 12, 26, 28, 31, 33], "an": [0, 1, 11, 22, 24, 31], "allow": [0, 1], "one": [0, 1, 9, 17], "elimin": [0, 1], "do": [0, 1, 6], "adher": [0, 1], "visual": [0, 1, 25], "heatmap": [0, 1, 10, 29, 32], "where": [0, 1, 3, 4, 5, 6, 7, 8, 9, 10, 26, 27, 28, 30, 31], "invalid": [0, 1, 9, 10, 26, 28], "ar": [0, 1, 3, 6, 9, 10, 11, 15, 16, 17, 24, 26, 27, 28, 29, 31, 32], "mask": [0, 1, 9, 12, 26, 27, 28, 29, 31, 32], "provid": [0, 1, 10, 17], "quick": [0, 1], "comprehens": [0, 1], "represent": [0, 1], "conceptul": [0, 1], "vizual": [0, 1], "tool": [0, 33], "util": [0, 1, 19, 20, 21, 22, 23, 24], "consist": [0, 6, 7, 33], "follow": 0, "modul": [0, 33], "core": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12], "function": [0, 2, 3, 9, 10, 13, 18, 25], "perform": [0, 2, 3, 11], "critieria": 0, "singl": [0, 10, 11, 12], "specif": [0, 3, 4, 6, 10, 11, 12, 16, 23, 26, 28, 30, 32], "answer": [0, 10, 12, 32], "io": [0, 14, 15, 16, 17], "csv": [0, 10, 14, 15, 16], "file": [0, 3, 10, 14, 15, 16, 17], "list": [0, 17], "process": [0, 14], "xlsx": 0, "variou": 0, "small": 0, "other": [0, 3, 17], "vi": [0, 26, 27, 28, 29, 30, 31, 32], "creat": [0, 10, 26, 27, 28, 29, 30, 31, 32], "plot": [0, 3, 8, 27, 30, 31], "tabl": [0, 16, 26], "etc": 0, "we": 0, "web": 0, "base": 0, "gui": 0, "streamlit": 0, "thi": [0, 3, 4, 6, 7, 8, 9, 10, 11], "app": 0, "host": 0, "server": 0, "avail": 0, "here": 0, "If": [0, 9, 10, 24], "certain": 0, "period": 0, "hibern": 0, "wake": 0, "up": 0, "request": 0, "mai": 0, "take": 0, "few": 0, "moment": 0, "load": [0, 31], "includ": [0, 4], "link": 0, "some": [0, 23], "which": [0, 10], "you": [0, 22], "can": [0, 3, 9, 10, 11], "explor": 0, "interfac": 0, "enjoi": 0, "depend": 0, "heavili": 0, "scipi": 0, "stack": 0, "best": [0, 27], "wai": 0, "fulli": 0, "environ": 0, "anaconda": 0, "distribut": 0, "Be": 0, "sure": 0, "python": 0, "3": [0, 3], "9": [0, 3], "version": 0, "onc": 0, "ve": 0, "conda": 0, "packag": [0, 10, 29, 32], "index": [0, 3, 22, 24], "type": 0, "prompt": [0, 10], "pip": 0, "On": 0, "window": 0, "should": 0, "shortcut": 0, "menu": 0, "open": 0, "command": 0, "consol": [0, 10], "access": 0, "featur": 0, "ad": 0, "thing": 0, "via": 0, "mac": 0, "linux": 0, "need": 0, "normal": [0, 29, 32], "termin": 0, "sourc": 0, "activ": 0, "env": 0, "replac": 0, "name": [0, 3, 9, 10, 11, 12, 16, 17, 21, 29, 31, 32], "want": 0, "don": 0, "t": [0, 7], "know": 0, "mean": 0, "default": [0, 5, 10, 12, 14, 29], "think": 0, "interest": 0, "contribut": 0, "wish": [0, 22], "both": 0, "edit": 0, "code": 0, "clone": 0, "repositori": 0, "your": 0, "local": 0, "machin": 0, "e": 0, "path": [0, 10, 16, 17, 20], "root": 0, "folder": 0, "For": [0, 22, 24], "inform": [0, 3, 10, 11, 14, 15, 16, 17], "about": [0, 10], "refer": [0, 1], "contributor": 0, "guid": 0, "snippet": 0, "illustr": 0, "how": 0, "produc": 0, "figur": [0, 10, 27, 29, 30, 31, 32], "repo": 0, "brows": 0, "envelop": 0, "user": [0, 10, 12, 17], "been": 0, "built": [0, 10], "later": [0, 10], "adsorb": [0, 3, 4, 6, 10, 11, 15, 16, 17, 23, 30], "cross": [0, 3, 10, 11, 16, 17], "section": [0, 3, 10, 11, 16, 17], "squar": [0, 3, 10, 11, 16], "angstrom": [0, 3, 10, 11, 16], "specifi": [0, 10, 12], "much": 0, "": [0, 8], "line": [0, 27], "bt": 0, "matplotlib": [0, 27, 31], "pylot": 0, "plt": 0, "fpath": 0, "get_fixtures_path": 0, "vulcan_chex": 0, "rouq_criteria": 0, "enforce_y_intercept_posit": [0, 9, 10], "true": [0, 9, 10, 27, 29, 30, 31, 32], "enforce_pressure_increas": [0, 9, 10], "enforce_absorbed_amount": [0, 9, 10], "enforce_relative_pressur": [0, 9, 10], "enforce_enough_datapoint": [0, 9, 10], "min_num_point": [0, 9, 10, 14], "5": [0, 5, 9, 10, 14], "aux_param": 0, "save_figur": [0, 10], "export_data": [0, 10], "fals": [0, 10, 30], "ssa_gradi": [0, 10], "green": [0, 10, 32], "err_gradi": [0, 10], "grei": [0, 10, 29], "run_beatmap": 0, "info": [0, 3, 10, 15, 16, 17], "chex": 0, "vulcan": 0, "a_o": [0, 3, 10, 11, 16, 17], "39": 0, "ssa_criterion": [0, 10], "error": [0, 3, 10, 12, 26, 27, 28, 29, 31], "altern": 0, "individu": [0, 3, 9], "more": [0, 10], "custom": 0, "import_data": 0, "first": [0, 3, 11, 16], "column": [0, 16], "second": [0, 6, 16], "amount": [0, 3, 4, 6, 9, 10, 11, 16, 17, 23, 30], "return": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 20, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32], "tupl": [0, 3, 9, 11, 12, 31], "entri": 0, "datafram": [0, 3, 4, 5, 6, 7, 9, 11, 15, 16, 17, 23, 26, 28], "2nd": 0, "4th": [0, 3], "field": [0, 9, 11, 15, 16, 17, 26, 28], "respect": [0, 10], "element": [0, 3, 26, 27, 28, 29, 30, 31, 32], "order": [0, 3], "prioriti": [0, 3], "given": [0, 3, 21], "isotherm_data": [0, 3, 15, 16, 17, 30], "everi": 0, "within": [0, 6], "accept": [0, 3, 9], "store": [0, 3, 11], "rather": [0, 3, 9], "than": [0, 3, 5, 9, 10], "pass": [0, 3, 6, 9, 10, 22], "paramet": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32], "output": [0, 3, 9, 10], "contain": [0, 2, 3, 5, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 23, 25, 26, 27, 28, 31], "well": 0, "raw": [0, 15, 23], "again": 0, "bet_result": [0, 3, 9, 11, 12, 14, 15, 26, 27, 28, 29, 31, 32], "iso_df": [0, 3, 9, 15, 26, 27, 28, 30, 31], "out": 0, "rouq_mask": [0, 12], "numpi": 0, "arrai": [0, 3, 4, 5, 6, 7, 8, 9, 11, 12, 22, 24], "correspond": [0, 3, 4, 5, 6, 7, 8, 9, 11, 12, 23, 29, 32], "each": [0, 9], "criterion": [0, 10, 12], "mask_result": [0, 12, 26, 27, 28, 29, 31, 32], "intercept": [0, 3, 6, 8, 9, 10], "nm": [0, 3, 4, 6, 9, 11, 31], "slope": [0, 3, 6, 9], "valu": [0, 3, 4, 5, 6, 8, 9, 10, 11, 12, 17, 22, 23, 24, 26, 27, 28, 29, 32], "concept": 0, "central": 0, "idea": 0, "ssa_heatmap": 0, "requir": [0, 5, 11, 14, 15, 16, 17], "experiment": [0, 3, 4, 5, 6, 7, 9, 11, 14, 17, 26, 28, 29, 30], "model": 0, "manner": 0, "see": 0, "document": 0, "full": 0, "summari": [0, 26, 28], "iso_combo_plot": 0, "save_fil": [0, 27, 29, 30, 31, 32], "might": 0, "desir": 0, "spreadsheet": 0, "sheet": 0, "save": [0, 10, 14, 15], "parent": [0, 10, 14, 15], "directori": [0, 10, 14, 15, 20, 27, 29, 30, 31, 32], "export_processed_data": 0, "rouquerol": [1, 26, 28], "criteria": [1, 10, 12, 26, 28], "result": [1, 3, 6, 9, 10, 11, 25, 26, 27, 28, 29, 31, 32], "get": [1, 21], "start": [1, 3], "api": 1, "bet": [2, 4, 5, 6, 7, 8, 9, 11, 14, 15, 16, 17, 26, 27, 28, 29, 31, 33], "analysi": [2, 3, 4, 5, 11, 14, 15, 16, 17, 26, 28], "beatmap": [3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 14, 15, 16, 17, 19, 20, 21, 22, 23, 24, 26, 27, 28, 29, 30, 31, 32, 33], "arg": [3, 9], "ani": [3, 10], "i": [3, 4, 5, 6, 7, 8, 9, 10, 14, 15, 16, 22, 24, 27, 29, 30, 31, 32, 33], "less": [3, 5], "end": 3, "written": [3, 15], "eg": [3, 10], "indici": [3, 11], "begin": 3, "point": [3, 4, 5, 9, 10, 11, 12, 14, 23, 31], "10th": 3, "import": [3, 4, 5, 6, 7, 16, 17], "float": [3, 10, 12, 16, 17, 23, 24, 26, 28], "str": [3, 10, 12, 15, 16, 17, 19, 21, 32], "namedtupl": [3, 9, 11, 14, 15, 16, 17, 26, 27, 28, 29, 30, 32], "ndarrai": [3, 4, 5, 6, 7, 8, 9, 11, 26, 28], "2d": [3, 4, 6, 8, 9, 11, 22, 24], "trendlin": 3, "last": [3, 11], "datapoint": [3, 10, 11, 27], "monolay": [3, 4, 6, 9, 10, 11, 31], "mol": [3, 11, 16, 17], "g": [3, 11, 16, 17], "ssa": [3, 10, 11, 12, 26, 28, 32], "m": [3, 11], "2": [3, 10, 11], "c": [3, 26, 28], "constant": [3, 26, 28], "err": [3, 26, 28, 29], "averag": [3, 26, 28, 29], "between": [3, 10, 11, 23, 29], "theoret": [3, 10, 29], "r": 3, "num_pt": 3, "number": [3, 5, 9, 10, 12, 14], "per": [3, 10, 17], "string": [3, 16, 17, 29], "df": [4, 5, 6, 7, 11, 23], "check": [4, 5, 6, 7, 8, 9, 11], "coordin": [4, 6], "unit": [4, 6, 17], "mole": [4, 6], "gram": [4, 6, 17], "1": [4, 5, 6, 7, 8, 9, 22, 24, 31], "0": [4, 5, 6, 7, 8, 9, 22, 24, 29], "n": [4, 6, 7, 10, 16, 17, 23, 31], "ie": [4, 6, 7, 8], "fail": [4, 6, 7, 8, 9], "minimum": [5, 9, 10, 12, 14, 24, 27, 31, 32], "int": [5, 9, 10, 14], "consid": [5, 9, 10, 14], "found": 6, "linear": [6, 7, 8], "interpol": [6, 23], "experiement": 6, "A": [6, 10], "set": [6, 10, 11, 27], "equat": [6, 27], "solv": 6, "two": [6, 16, 17, 23], "compar": 6, "agre": 6, "10": [6, 10], "regress": [6, 8], "relev": [6, 11, 15, 16, 17, 26, 28], "y": [6, 8, 10, 30], "p": [7, 10, 33], "po": [7, 10], "aka": 7, "check2": [7, 9, 10], "increas": 7, "necessari": [7, 10], "condit": 7, "dataset": 7, "isn": 7, "posit": 8, "neg": [8, 10], "zero": 8, "call": 9, "combin": 9, "rouqerol": 9, "check1": [9, 10], "check3": [9, 10], "check4": [9, 10], "bool": [9, 10, 27, 32], "otherwis": 9, "skip": 9, "enforce_absorbed_amount_valid": 9, "enforce_relative_pressure_valid": 9, "interv": [9, 14], "select": [9, 10], "maskedarrai": [9, 26, 28], "object": [9, 26, 27, 28, 31], "check5": [9, 10], "none": [10, 14, 15, 16, 17, 29, 30, 32], "execut": 10, "algorithim": 10, "friendli": 10, "possibl": 10, "Or": 10, "left": 10, "empti": 10, "input": 10, "them": 10, "myfil": 10, "nitrogen": 10, "carbon": 10, "16": 10, "In": 10, "case": 10, "former": 10, "through": 10, "promt": 10, "addit": 10, "roquerol": 10, "defin": [10, 12], "reason": 10, "decreas": 10, "fall": 10, "outsid": 10, "disagr": 10, "actual": 10, "coverag": 10, "occur": [10, 31], "fewer": 10, "png": [10, 27, 29, 30, 31, 32], "export": [10, 14, 15], "lowest": [10, 12], "most": [10, 12, 22], "color": [10, 29, 32], "gradient": [10, 29, 32], "vaild": [10, 29, 32], "seaborn": [10, 29, 32], "agreement": 11, "also": 11, "raw_data": 11, "flaot": 11, "molecul": [11, 16], "singlept_result": 11, "log": 12, "maximum": [12, 24, 27, 29, 32], "remov": 12, "invaid": 12, "consider": 12, "final": 12, "either": 12, "max": [12, 24], "min": [12, 24], "ssa_an": 12, "read": 13, "write": 13, "format": [16, 26], "expect": 16, "being": 16, "buffer": 16, "short": 16, "descript": 16, "identifi": 16, "iso_data": [16, 17], "relp": [17, 23, 26, 28], "helper": 18, "throughout": 18, "librari": 18, "package_nam": 19, "fixtur": 20, "logger": 21, "find": [22, 23, 24], "similar": 22, "numer": 22, "idx": 22, "j": [22, 24], "val": 23, "linerarli": 23, "design": 23, "realtaiv": 23, "interp_v": 23, "multipl": 24, "exist": 24, "max_idx": 24, "min_idx": 24, "print": 26, "ascii": 26, "prettyt": 26, "highlight": [26, 28], "high": [26, 28], "low": [26, 28], "table2": 26, "ssa_std": [26, 28], "atandard": [26, 28], "deviat": [26, 28], "c_std": [26, 28], "standard": [26, 28], "maxium": 27, "onli": [27, 29, 31, 32], "fit": 27, "r2": 27, "annot": 27, "displai": [27, 29, 31, 32], "when": [27, 29, 30, 31, 32], "work": [27, 29, 30, 31, 32], "ax": [27, 31], "popul": 28, "panda": 28, "summar": 28, "ssa_tabl": 28, "c_tabl": 28, "shade": [29, 32], "white": 29, "black": 29, "boolean": [29, 30, 31], "scatter": 30, "typic": 30, "present": 30, "x": 30, "axi": 30, "imag": 31, "same": 31, "sa": 32, "four": 33, "main": 33, "determin": 33, "p0": 33}, "objects": {"": [[33, 0, 0, "-", "beatmap"]], "beatmap": [[2, 0, 0, "-", "core"], [13, 0, 0, "-", "io"], [18, 0, 0, "-", "utils"], [25, 0, 0, "-", "vis"]], "beatmap.core": [[3, 1, 1, "", "bet"], [4, 1, 1, "", "check_absorbed_amount"], [5, 1, 1, "", "check_enough_datapoints"], [6, 1, 1, "", "check_pressure_consistency"], [7, 1, 1, "", "check_pressure_increasing"], [8, 1, 1, "", "check_y_intercept_positive"], [9, 1, 1, "", "rouq_mask"], [10, 1, 1, "", "run_beatmap"], [11, 1, 1, "", "single_point_bet"], [12, 1, 1, "", "ssa_answer"]], "beatmap.io": [[14, 1, 1, "", "export_processed_data"], [15, 1, 1, "", "export_raw_data"], [16, 1, 1, "", "import_data"], [17, 1, 1, "", "import_list_data"]], "beatmap.utils": [[19, 1, 1, "", "find_package_root"], [20, 1, 1, "", "get_fixtures_path"], [21, 1, 1, "", "get_logger"], [22, 1, 1, "", "index_of_value"], [23, 1, 1, "", "lin_interp"], [24, 1, 1, "", "max_min"]], "beatmap.vis": [[26, 1, 1, "", "ascii_tables"], [27, 1, 1, "", "bet_combo_plot"], [28, 1, 1, "", "dataframe_tables"], [29, 1, 1, "", "err_heatmap"], [30, 1, 1, "", "experimental_data_plot"], [31, 1, 1, "", "iso_combo_plot"], [32, 1, 1, "", "ssa_heatmap"]]}, "objtypes": {"0": "py:module", "1": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "titleterms": {"get": 0, "start": 0, "what": [0, 1], "i": [0, 1], "beatmap": [0, 1], "capabl": 0, "try": 0, "It": 0, "live": 0, "instal": 0, "exampl": 0, "autom": 0, "bet": [0, 1, 3], "analysi": [0, 1], "manual": 0, "import": 0, "dataset": 0, "rouquerol": 0, "criteria": 0, "supplementari": 0, "export": 0, "result": 0, "tool": 1, "content": [1, 33], "core": 2, "check_absorbed_amount": 4, "check_enough_datapoint": 5, "check_pressure_consist": 6, "check_pressure_increas": 7, "check_y_intercept_posit": 8, "rouq_mask": 9, "run_beatmap": 10, "single_point_bet": 11, "ssa_answ": 12, "io": 13, "export_processed_data": 14, "export_raw_data": 15, "import_data": 16, "import_list_data": 17, "util": 18, "find_package_root": 19, "get_fixtures_path": 20, "get_logg": 21, "index_of_valu": 22, "lin_interp": 23, "max_min": 24, "vi": 25, "ascii_t": 26, "bet_combo_plot": 27, "dataframe_t": 28, "err_heatmap": 29, "experimental_data_plot": 30, "iso_combo_plot": 31, "ssa_heatmap": 32, "api": 33, "refer": 33}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 60}, "alltitles": {"Getting Started": [[0, "getting-started"]], "What is BEaTmap?": [[0, "what-is-beatmap"], [1, "what-is-beatmap"]], "Capabilities": [[0, "capabilities"]], "Try It Live": [[0, "try-it-live"]], "Installation": [[0, "installation"]], "Examples": [[0, "examples"]], "Automated BET analysis": [[0, "automated-bet-analysis"]], "Manual BET analysis": [[0, "manual-bet-analysis"]], "Import the dataset": [[0, "import-the-dataset"]], "BET analysis": [[0, "bet-analysis"]], "Rouquerol criteria": [[0, "rouquerol-criteria"]], "Supplementary analysis": [[0, "supplementary-analysis"]], "Export the results": [[0, "export-the-results"]], "BEaTmap: BET Analysis Tool": [[1, "beatmap-bet-analysis-tool"]], "Contents": [[1, "contents"], [33, "module-beatmap"]], "core": [[2, "module-beatmap.core"], [2, "id1"]], "bet": [[3, "bet"]], "check_absorbed_amount": [[4, "check-absorbed-amount"]], "check_enough_datapoints": [[5, "check-enough-datapoints"]], "check_pressure_consistency": [[6, "check-pressure-consistency"]], "check_pressure_increasing": [[7, "check-pressure-increasing"]], "check_y_intercept_positive": [[8, "check-y-intercept-positive"]], "rouq_mask": [[9, "rouq-mask"]], "run_beatmap": [[10, "run-beatmap"]], "single_point_bet": [[11, "single-point-bet"]], "ssa_answer": [[12, "ssa-answer"]], "io": [[13, "module-beatmap.io"], [13, "id1"]], "export_processed_data": [[14, "export-processed-data"]], "export_raw_data": [[15, "export-raw-data"]], "import_data": [[16, "import-data"]], "import_list_data": [[17, "import-list-data"]], "utils": [[18, "module-beatmap.utils"], [18, "id1"]], "find_package_root": [[19, "find-package-root"]], "get_fixtures_path": [[20, "get-fixtures-path"]], "get_logger": [[21, "get-logger"]], "index_of_value": [[22, "index-of-value"]], "lin_interp": [[23, "lin-interp"]], "max_min": [[24, "max-min"]], "vis": [[25, "module-beatmap.vis"], [25, "id1"]], "ascii_tables": [[26, "ascii-tables"]], "bet_combo_plot": [[27, "bet-combo-plot"]], "dataframe_tables": [[28, "dataframe-tables"]], "err_heatmap": [[29, "err-heatmap"]], "experimental_data_plot": [[30, "experimental-data-plot"]], "iso_combo_plot": [[31, "iso-combo-plot"]], "ssa_heatmap": [[32, "ssa-heatmap"]], "API Reference": [[33, "api-reference"]]}, "indexentries": {"beatmap.core": [[2, "module-beatmap.core"]], "module": [[2, "module-beatmap.core"], [13, "module-beatmap.io"], [18, "module-beatmap.utils"], [25, "module-beatmap.vis"], [33, "module-beatmap"]], "bet() (in module beatmap.core)": [[3, "beatmap.core.bet"]], "check_absorbed_amount() (in module beatmap.core)": [[4, "beatmap.core.check_absorbed_amount"]], "check_enough_datapoints() (in module beatmap.core)": [[5, "beatmap.core.check_enough_datapoints"]], "check_pressure_consistency() (in module beatmap.core)": [[6, "beatmap.core.check_pressure_consistency"]], "check_pressure_increasing() (in module beatmap.core)": [[7, "beatmap.core.check_pressure_increasing"]], "check_y_intercept_positive() (in module beatmap.core)": [[8, "beatmap.core.check_y_intercept_positive"]], "rouq_mask() (in module beatmap.core)": [[9, "beatmap.core.rouq_mask"]], "run_beatmap() (in module beatmap.core)": [[10, "beatmap.core.run_beatmap"]], "single_point_bet() (in module beatmap.core)": [[11, "beatmap.core.single_point_bet"]], "ssa_answer() (in module beatmap.core)": [[12, "beatmap.core.ssa_answer"]], "beatmap.io": [[13, "module-beatmap.io"]], "export_processed_data() (in module beatmap.io)": [[14, "beatmap.io.export_processed_data"]], "export_raw_data() (in module beatmap.io)": [[15, "beatmap.io.export_raw_data"]], "import_data() (in module beatmap.io)": [[16, "beatmap.io.import_data"]], "import_list_data() (in module beatmap.io)": [[17, "beatmap.io.import_list_data"]], "beatmap.utils": [[18, "module-beatmap.utils"]], "find_package_root() (in module beatmap.utils)": [[19, "beatmap.utils.find_package_root"]], "get_fixtures_path() (in module beatmap.utils)": [[20, "beatmap.utils.get_fixtures_path"]], "get_logger() (in module beatmap.utils)": [[21, "beatmap.utils.get_logger"]], "index_of_value() (in module beatmap.utils)": [[22, "beatmap.utils.index_of_value"]], "lin_interp() (in module beatmap.utils)": [[23, "beatmap.utils.lin_interp"]], "max_min() (in module beatmap.utils)": [[24, "beatmap.utils.max_min"]], "beatmap.vis": [[25, "module-beatmap.vis"]], "ascii_tables() (in module beatmap.vis)": [[26, "beatmap.vis.ascii_tables"]], "bet_combo_plot() (in module beatmap.vis)": [[27, "beatmap.vis.bet_combo_plot"]], "dataframe_tables() (in module beatmap.vis)": [[28, "beatmap.vis.dataframe_tables"]], "err_heatmap() (in module beatmap.vis)": [[29, "beatmap.vis.err_heatmap"]], "experimental_data_plot() (in module beatmap.vis)": [[30, "beatmap.vis.experimental_data_plot"]], "iso_combo_plot() (in module beatmap.vis)": [[31, "beatmap.vis.iso_combo_plot"]], "ssa_heatmap() (in module beatmap.vis)": [[32, "beatmap.vis.ssa_heatmap"]], "beatmap": [[33, "module-beatmap"]]}}) \ No newline at end of file