nsls-ii / docs Goto Github PK
View Code? Open in Web Editor NEWStandards Documentation for NSLS-II DAQ and Analysis
Home Page: https://nsls-ii.github.io
License: BSD 2-Clause "Simplified" License
Standards Documentation for NSLS-II DAQ and Analysis
Home Page: https://nsls-ii.github.io
License: BSD 2-Clause "Simplified" License
Direct people to https://logbook.nsls2.bnl.gov
Add examples for using the peak stats estimations in ophyd/userapi/scan_api.py
Navigating amongst the different components could be easier if there were cross-references between components.
For example: bluesky should point to (at least) NSLS-II Software Documentation
This would be most accessible somewhere in the left sidebar.
Rather than decide which things to put in the sidebar, put the same block of all components in the sidebar of every component. This will help document and unify the entire suite of software.
We should set up Uptime Robot to notify [email protected] when any of our public sites fall over. Prompted by scikit-beam/scikit-beam#543
Instead link to the bluesky, databroker, and (forthcoming) ophyd tutorials.
h/t @mrakitin
A new version of tomopy
can be installed with pip install .
. See #97 which uses this new approach and installs tomopy
from the master branch. Once the new version of tomopy
is tagged/released (most likely https://github.com/tomopy/tomopy/releases/tag/1.2.2), we should use the tagged version and install it with:
pip install git+https://github.com/tomopy/[email protected]
Currently, we install the dxchange
package from the master branch of their repo:
Line 25 in c1bd534
dxchange
is updated (see my issue data-exchange/dxchange#81), we will be able to install it with:
pip install git+https://github.com/data-exchange/[email protected]
@danielballan
for this code:
https://github.com/NSLS-II/nslsii/blob/master/nslsii/__init__.py
add documentation to:
https://github.com/NSLS-II/docs/blob/master/source/fresh-installation.rst
example:
import nslsii
nslsii.configure_base(get_ipython().user_ns, 'iss', pbar=False, bec=False)
inline ipython dumped traceback cuz it can't connect to the db
https://nsls-ii.github.io/broker/basics.html
/filestore/index.html
/examples/show-and-plot-scalar-data.html
/examples/advanced-live-plot.html
4 levels of device definition / instantiation
I suggest a new section: NSLS-II packaging practices (or hierarchy)
@tacaswell ?
Creating an issue so we don't forget to make sure this gets done.
Was doing some fs work on 5id and had this doc pointed out to me.
https://github.com/NSLS-II/docs/blob/master/deploying/metadatastore.rst
The general bluesky project content will move to bluesky.github.io (aliased as blueskyproject.io). This repository will focus on local deployment documentation and resources.
Did we decide that every document type in metadatastore has a time
field?
I suggest adding caproto (requested by Dan Flath, who looked for it there and was surprised not to find it) and removing amostra and datamuxer at least for now, as presently dormant and poorly documented. Objections?
One issue. For adding a jupyter kernel, I had to change from using the hostname string to a specific IP address. I'm not sure where along the chain the issue is.
However, this could be an issue that others encounter. I'd suggest adding to these docs
https://nsls-ii.github.io/conda.html#access-custom-user-environments-in-nsls-ii-s-jupyterhub
something like:
tip : if you are having kernel connection problems, try replacing the hostname with an actual ip address. You may find your ip address by typing ip addr
on the host machine.
@danielballan do you agree? i will PR if yes. This issue is also meant to flag this general problem
Once @danielballan PR into doctr is resolved (drdoctr/doctr#190) and the version of doctr is release. Then we should stop installing Dan's version and go back to the standard doctr.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.