β οΈ Brightway Live is in Public Beta β οΈ
", - # page elements - "navbar_start": ["navbar-logo"], - "navbar_end": ["navbar-icon-links.html"], - "footer_start": ["copyright"], - "footer_center": ["footer_center"], - "footer_end": ["footer_end"], - "secondary_sidebar_items": ["page-toc"], - "header_links_before_dropdown": 7, - # page elements content - "icon_links": [ - { - "name": "GitHub", - "url": "https://github.com/brightway-lca", - "icon": "fab fa-brands fa-github", - }, - { - "name": "Matrix", - "url": "https://app.element.io/#/room/#brightway/community:matrix.org", - "icon": "fab fa-regular fa-comments", - } - ], - # various settings - "collapse_navigation": True, - "show_prev_next": False, - "use_edit_page_button": True, - "navigation_with_keys": True, - "logo": { - "text": "Brightway Live", - "image_light": "BW_all_black_transparent_landscape.svg", - "image_dark": "BW_all_white_transparent_landscape.svg" - }, -} - -# required by html_theme_options: "use_edit_page_button" -html_context = { - "github_user": "brightway-lca", - "github_repo": "brightway-documentation", - "github_version": "main", - "doc_path": "source", -} - -#################################################################################################### -### Extension Configuration ######################################################################## -#################################################################################################### - -# linkcheck Configuration ############################################### -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-the-linkcheck-builder - -linkcheck_retries = 1 -linkcheck_workers = 20 -linkcheck_exclude_documents = [] - -# notfound Configuration ################################################ -# https://sphinx-notfound-page.readthedocs.io - -notfound_context = { - 'title': 'Page Not Found', - 'body': ''' -π Page Not Found (404)
-- Oops! It looks like you've stumbled upon a page that's been recycled into the digital abyss. - But don't worry, we're all about sustainability here. - Why not take a moment to reduce, reuse, and recycle your clicks by heading back to the main page? - And remember, every little bit counts in the grand scheme of things. -
- ''', -} - -# myst_parser Configuration ############################################ -# https://myst-parser.readthedocs.io/en/latest/configuration.html - -source_suffix = { - '.rst': 'restructuredtext', - '.md': 'markdown' -} - -myst_enable_extensions = [ - "amsmath", - "colon_fence", - "deflist", - "dollarmath", - "html_image", -] - -# sphinx-favicon configuration ######################################### -# https://github.com/tcmetzger/sphinx-favicon - -favicons = [ - { - "rel": "icon", - "sizes": "100x100", - "href": "logo/BW_favicon_100x100.png", - }, - { - "rel": "apple-touch-icon", - "sizes": "500x500", - "href": "logo/BW_favicon_500x500.png" - }, -] diff --git a/docs/content/cheat_sheet.md b/docs/content/cheat_sheet.md deleted file mode 100644 index 64796d4..0000000 --- a/docs/content/cheat_sheet.md +++ /dev/null @@ -1,23 +0,0 @@ -# Cheat Sheet - -## Reset the JupyterLite Environment - -Currently, the interface of the JupiterLite environment does not provide a way to reset the environment. - -Related Issues: - -- [jupyterlite/jupyterlite#9](https://github.com/jupyterlite/jupyterlite/issues/9) -- -This means that the environment must be reset manually. Usually, all data is stored in the browser's IndexedDB. You can reset the environment in your browser by following these steps: - -Google Chrome: - -``` -Developer > Developer Tools > Application > Storage > Indexed DB > JupyterLite Storage > Delete Database -``` - -Mozilla Firefox: - -``` -Tools > Page Info > Permissions > Maintain Offline Storage > Clear Storage -``` \ No newline at end of file diff --git a/docs/content/limitations.md b/docs/content/limitations.md deleted file mode 100644 index c5d13a9..0000000 --- a/docs/content/limitations.md +++ /dev/null @@ -1,37 +0,0 @@ -# Limitations - -Currently, an error is raised when trying to query a SQLite database in JupyterLite. This affects the use of Brightway, which stores data in sqlite databases through the `peewee` Python library. For instance, this simple test of the `peewee` library: - -```python -from peewee import * - -# Define a database object -db = SqliteDatabase('my_database.db') - -# Define a model class -class Person(Model): - name = CharField() - age = IntegerField() - - class Meta: - database = db - -# Create the table in the database -db.connect() -db.create_tables([Person]) - -person1 = Person(name='Alice', age=25) -person1.save() -``` - -raises the following error: - -``` -DatabaseError: database disk image is malformed -``` - -The current workaround is documented here: - - - https://github.com/brightway-lca/brightway-live/issues/10 - -Instead of the default storage location a different location at `/tmp/` must be specified for the database. This is done [by setting the `BRIGHTWAY_DIR` environment variable](https://docs.brightway.dev/en/latest/content/faq/data_management.html#how-do-i-change-my-data-directory). \ No newline at end of file diff --git a/docs/content/use.md b/docs/content/use.md deleted file mode 100644 index e15de8c..0000000 --- a/docs/content/use.md +++ /dev/null @@ -1,21 +0,0 @@ -# Use - -## Reset the JupyterLite Environment - -### Delete the JupyterLite Storage - -Currently, the interface of the JupiterLite environment does not provide a way to reset the environment. - -##### Related Issues: - -- https://github.com/jupyterlite/jupyterlite/issues/9 - -This means that the environment must be reset manually. [Usually](https://jupyterlite.readthedocs.io/en/latest/howto/configure/storage.html), all data is stored in the browser's `IndexedDB`. You can reset the environment in your browser by following these steps: - -- [Google Chrome](https://github.com/jupyterlite/jupyterlite/issues/9#issuecomment-875870620): - -> Developer > Developer Tools > Application > Storage > Indexed DB > JupyterLite Storage > Delete Database - -- Mozilla Firefox: - -> Tools > Page Info > Permissions > Maintain Offline Storage > Clear Storage \ No newline at end of file diff --git a/docs/environment.yaml b/docs/environment.yaml deleted file mode 100644 index 93c890b..0000000 --- a/docs/environment.yaml +++ /dev/null @@ -1,19 +0,0 @@ -name: sphinx -channels: - - conda-forge - - nodefaults -dependencies: - # core functionality - - python=3.11 - - ipython - # sphinx - - sphinx=7.2.6 # core builder # https://anaconda.org/conda-forge/sphinx/files - # theme and extensions - - pydata-sphinx-theme=0.14.0 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files - - myst-parser=2.0.0 # Markdown support # https://anaconda.org/conda-forge/myst-parser/files - - sphinx-design=0.5.0 # responsive web component support # https://anaconda.org/conda-forge/sphinx-design/files - - sphinx-notfound-page=1.0.0 # custom 404 page # https://anaconda.org/conda-forge/sphinx-notfound-page/files - - sphinx-favicon=1.0.1 # for custom favicons # https://anaconda.org/conda-forge/sphinx-favicon/files - - sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files - # build process - - sphinx-autobuild=2021.3.14 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 70b5938..0000000 --- a/docs/index.md +++ /dev/null @@ -1,25 +0,0 @@ -# Brightway Live - -## What is Brightway Live? - -Brightway Live is a Python-based development environment [^1] that runs entirely in the browser. This means that it is independent of the hardware, the operating system or the local Python environment of the user. It is powered by WebAssembly [^2] and JupyterLite [^3]. It was built by [Michael Weinold](https://github.com/michaelweinold) after learning about the possibilities of Python in WebAssembly at the EuroSciPy conference in Basel in 2022. - -## What can I do with Brightway Live? - -At the moment, you can play around with it. You can load brightway packages (eg. `bw2io`, `bw2calc`, `bw2data` and `bw2analyzer`) and use them in a Jupyter Notebook or in a Python console. In the long run, you will be able to use this to teach life-cycle assessment with Brightway at scale. You will not need to worry about installation or setup of the software. You will not need to worry about the different hardware and operating systems that your students bring to class. You will not need to worry about setting up a JupyterHub server and the associated overhead. - -