πΏπ Found a bug? Something not working? Frustrated? Please report it!
\ No newline at end of file diff --git a/docs/_templates/footer_center.html b/docs/_templates/footer_center.html new file mode 100644 index 0000000..3e024aa --- /dev/null +++ b/docs/_templates/footer_center.html @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/_templates/footer_end.html b/docs/_templates/footer_end.html new file mode 100644 index 0000000..b643889 --- /dev/null +++ b/docs/_templates/footer_end.html @@ -0,0 +1 @@ +πΏπ Found a bug? Something not working? Frustrated? Please report it!
\ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 708d758..e11a0f3 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -69,13 +69,16 @@ ], } +footcent = str('test') + html_theme_options = { - "announcement": "Join the Discussion: π¬ Brightway Community Chat Rooms on Matrix
", + "announcement": "β οΈ Brightway Live is in Public Beta β οΈ
", # page elements "navbar_start": ["navbar-logo"], "navbar_end": ["navbar-icon-links.html"], "footer_start": ["copyright"], - "footer_end": ["footer"], + "footer_center": ["footer_center"], + "footer_end": ["footer_end"], "secondary_sidebar_items": ["page-toc"], "header_links_before_dropdown": 7, # page elements content @@ -97,7 +100,7 @@ "use_edit_page_button": True, "navigation_with_keys": True, "logo": { - "text": "Brightway", + "text": "Brightway Live", "image_light": "BW_all_black_transparent_landscape.svg", "image_dark": "BW_all_white_transparent_landscape.svg" }, diff --git a/docs/content/cheat_sheet.md b/docs/content/cheat_sheet.md new file mode 100644 index 0000000..64796d4 --- /dev/null +++ b/docs/content/cheat_sheet.md @@ -0,0 +1,23 @@ +# 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 index d817c64..c5d13a9 100644 --- a/docs/content/limitations.md +++ b/docs/content/limitations.md @@ -1,2 +1,37 @@ -# Brightway Live Limitation +# 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 new file mode 100644 index 0000000..e15de8c --- /dev/null +++ b/docs/content/use.md @@ -0,0 +1,21 @@ +# 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/index.md b/docs/index.md index 9d84dff..70b5938 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,12 +1,25 @@ -# Brightway Live π +# Brightway Live ## What is Brightway Live? -This is an excellent question! +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. + +