From bc6e4ff88525e58f3309c46d2ed4df5521c8ea8d Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 30 May 2024 11:57:04 +0100 Subject: [PATCH 1/4] update readme --- README.rst | 19 +++++++++---------- 1 file changed, 9 insertions(+), 10 deletions(-) diff --git a/README.rst b/README.rst index 5d10ea053f..34cc585fab 100644 --- a/README.rst +++ b/README.rst @@ -28,15 +28,15 @@ Direct dependencies of OMERO.web are: Installation ------------ -We recommend installing omero-web in a Python virtual environment. -Here we show the install using `Conda`_. For more details and -other options, please see `OMERO.py`_. +We recommend installing ``omero-web`` in a Python virtual environment. +Before installing ``omero-web``, we recommend to install the `ZeroC IcePy`_ Python bindings. +Our commercial partner `Glencoe Software `_ has produced several Python wheels to install the Ice-Python bindings depending on the desired Python version and the operating system. Please visit `OMERO Python language bindings `_ for a list of supported platforms and Python versions. + +When the wheel is installed, activate the virtual environment and install ``omero-web`` from `PyPI `_. :: - conda create -n myenv python=3.9 conda-forge::zeroc-ice==3.6.5 omero-py - conda activate myenv - pip install omero-web + pip install -U omero-web Setting of the environment variable ``OMERODIR`` is required. ``$OMERODIR/var/log/`` directory will contain log files. @@ -68,7 +68,7 @@ to source files will be reflected in your installation. cd omero-web pip install -e . -Note some omero-web tests may not run when this module and/or omero-py are installed in editable mode. +Note some ``omero-web`` tests may not run when this module and/or ``omero-py`` are installed in editable mode. Configuration for developer usage:: @@ -156,10 +156,9 @@ Copyright 2009-2024, The Open Microscopy Environment, Glencoe Software, Inc. .. _OMERO: https://www.openmicroscopy.org/omero -.. _OMERO.web install: https://docs.openmicroscopy.org/latest/omero/sysadmins/unix/install-web/web-deployment.html +.. _OMERO.web install: https://omero.readthedocs.io/en/stable/sysadmins/unix/install-web/web-deployment.html .. _OMERO.py: https://pypi.python.org/pypi/omero-py .. _ZeroC IcePy: https://zeroc.com/ .. _Pillow: https://python-pillow.org/ .. _NumPy: http://matplotlib.org/ -.. _Running and writing tests: https://docs.openmicroscopy.org/latest/omero/developers/testing.html -.. _Conda: https://docs.conda.io/en/latest/ +.. _Running and writing tests: https://omero.readthedocs.io/en/stable//omero/developers/testing.html \ No newline at end of file From c13821b0f174256b9e14f8c24c3dc629d932c993 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 30 May 2024 12:03:05 +0100 Subject: [PATCH 2/4] update zeroc link --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 34cc585fab..06fd5b9c35 100644 --- a/README.rst +++ b/README.rst @@ -158,7 +158,7 @@ Copyright .. _OMERO: https://www.openmicroscopy.org/omero .. _OMERO.web install: https://omero.readthedocs.io/en/stable/sysadmins/unix/install-web/web-deployment.html .. _OMERO.py: https://pypi.python.org/pypi/omero-py -.. _ZeroC IcePy: https://zeroc.com/ +.. _ZeroC IcePy: https://zeroc.com/downloads/ice/3.6 .. _Pillow: https://python-pillow.org/ .. _NumPy: http://matplotlib.org/ .. _Running and writing tests: https://omero.readthedocs.io/en/stable//omero/developers/testing.html \ No newline at end of file From 575f7bbc72aad997963937297f08156ca6f7dd5e Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Thu, 30 May 2024 12:06:18 +0100 Subject: [PATCH 3/4] minor edit --- README.rst | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index 06fd5b9c35..e9828ce40c 100644 --- a/README.rst +++ b/README.rst @@ -34,15 +34,16 @@ Before installing ``omero-web``, we recommend to install the `ZeroC IcePy`_ Pyth Our commercial partner `Glencoe Software `_ has produced several Python wheels to install the Ice-Python bindings depending on the desired Python version and the operating system. Please visit `OMERO Python language bindings `_ for a list of supported platforms and Python versions. When the wheel is installed, activate the virtual environment and install ``omero-web`` from `PyPI `_. + :: - pip install -U omero-web + $ pip install -U omero-web Setting of the environment variable ``OMERODIR`` is required. ``$OMERODIR/var/log/`` directory will contain log files. ``$OMERODIR/etc/grid/config.xml`` is used to store config:: - export OMERODIR=$(pwd) + $ export OMERODIR=$(pwd) Usage ----- @@ -64,30 +65,30 @@ to source files will be reflected in your installation. :: - git clone https://github.com/ome/omero-web - cd omero-web - pip install -e . + $ git clone https://github.com/ome/omero-web + $ cd omero-web + $ pip install -e . Note some ``omero-web`` tests may not run when this module and/or ``omero-py`` are installed in editable mode. Configuration for developer usage:: - omero config set omero.web.debug True - omero config set omero.web.application_server development + $ omero config set omero.web.debug True + $ omero config set omero.web.application_server development # If you want to connect to OMERO.server other than 'localhost' - omero config append omero.web.server_list '["demo.openmicroscopy.org", 4064, "demo"]' + $ omero config append omero.web.server_list '["demo.openmicroscopy.org", 4064, "demo"]' Then run omero-web in the foreground with:: - omero web start + $ omero web start ... Starting development server at http://127.0.0.1:4080/ Or, run Django directly:: - cd omero-web - python omeroweb/manage.py runserver 4080 + $ cd omero-web + $ python omeroweb/manage.py runserver 4080 ... Starting development server at http://127.0.0.1:4080/ From 835cfbc948305ce221d873b2a8beb5be288ca9f8 Mon Sep 17 00:00:00 2001 From: Jean-Marie Burel Date: Fri, 12 Jul 2024 05:20:36 +0100 Subject: [PATCH 4/4] remove extra character --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index e9828ce40c..3fa322d3da 100644 --- a/README.rst +++ b/README.rst @@ -162,4 +162,4 @@ Copyright .. _ZeroC IcePy: https://zeroc.com/downloads/ice/3.6 .. _Pillow: https://python-pillow.org/ .. _NumPy: http://matplotlib.org/ -.. _Running and writing tests: https://omero.readthedocs.io/en/stable//omero/developers/testing.html \ No newline at end of file +.. _Running and writing tests: https://omero.readthedocs.io/en/stable/omero/developers/testing.html