From 0fb9975e23bd686742622410c31c7d8a0594d6db Mon Sep 17 00:00:00 2001 From: Matt Coomber Date: Wed, 2 Apr 2025 21:48:07 +0000 Subject: [PATCH] Clarify supported python versions and folder structure for metrics builds --- docs/resim/index.md | 4 ++++ docs/resim/metrics/metrics_builds.md | 2 +- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/resim/index.md b/docs/resim/index.md index daf41d00..c1f27766 100644 --- a/docs/resim/index.md +++ b/docs/resim/index.md @@ -7,10 +7,14 @@ code intended to accelerate robotics development. A number of our libraries have Python bindings or implementations, such as a subset of the `transforms` and `metrics` libraries as well as a Python client for the ReSim API. These are distributed as part of our [Python package](https://pypi.org/project/resim-open-core/) which can be easily installed using `pip`. + ```bash pip install resim-open-core ``` +!!! Note + Currently, this package is only built for Python 3.10, supporting Linux for x86_64 and aarch64 architectures. + If you're using C++ and Bazel, you can follow the development instructions below to build some examples and explore our libraries. ## Development diff --git a/docs/resim/metrics/metrics_builds.md b/docs/resim/metrics/metrics_builds.md index 2af383ee..fbe3c808 100644 --- a/docs/resim/metrics/metrics_builds.md +++ b/docs/resim/metrics/metrics_builds.md @@ -18,7 +18,7 @@ Metrics Builds have three modes, two of which *must implemented within the same Whether we are in `test mode` or `batch mode` is determined by the files present in `/tmp/resim/inputs/` when the metrics build container runs. - If the file `/tmp/resim/inputs/batch_metrics_config.json` is present, we are in batch mode, and our build should compute batch metrics using this config. -- If the file `/tmp/resim/inputs/batch_metrics_config.json` is *not* present, then we are in test mode, and our build should compute test metrics. In this case, `/tmp/resim/inputs/` will instead contain an `experience` and `logs` directory respectively containing the input and output of the test which we can use to compute our metrics. +- If the file `/tmp/resim/inputs/batch_metrics_config.json` is *not* present, then we are in test mode, and our build should compute test metrics. In this case, `/tmp/resim/inputs/` will contain an `experience` and `logs` directory. The `experience` directory will contain the experience data from the test (e.g. the `/tmp/resim/inputs` folder from the experience stage), and the `logs` directory will contain the log data (e.g. the `/tmp/resim/outputs` folder from the experience stage). ## Test Suite Report Mode