Skip to content

Commit 0d66622

Browse files
committed
Removed 2.3 verbage from readme
1 parent f48d801 commit 0d66622

File tree

1 file changed

+21
-33
lines changed

1 file changed

+21
-33
lines changed

README.md

Lines changed: 21 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,32 @@
1-
# das2C - version 3.0 (in work)
1+
# das2C - version 3.0
22

33
[![Anaconda Package](https://anaconda.org/dasdevelopers/das2c/badges/version.svg)](https://anaconda.org/dasdevelopers/das2c)
44

5-
**Note: The main branch is under development. For a stable API use the 2.3 release.**
6-
75
Das servers typically provide data relavent to space plasma and magnetospheric
86
physics research. To retrieve data, an HTTP GET request is posted to a das
97
server by a client program and a self-describing stream of data values covering
108
the requested time range, at the requested time resolution, is provided in the
119
response body.
1210

13-
This package, *das2C*, provides a portable C library, libdas.so.3, which
14-
contains functions for:
11+
This package, *das2C*, provides a portable C libraries and programs for:
1512

1613
* Reading and writing dasStream versions 2.x and 3.X
17-
* Virtual variable creation
1814
* General SI unit manipulation
1915
* Dataset accumulation
20-
* Federated catalog navigation
16+
* Generating spectrograms from time series data
17+
* Time averaging long duration spectrograms
18+
* Performing SPICE operations on data streams
19+
* Converting streams into export formats such as CSV and CDF.
2120

22-
as well as a set of stream processing programs used by
23-
[dasflex](https://github.com/das-developers/das2-pyserver) for:
21+
The core library is used by [das2py](https://github.com/das-developers/das2py) and
22+
[das2dlm](https://github.com/das-developers/das2dlm).
23+
24+
Das2C utility programs are used by [dasFlex](https://github.com/das-developers/dasFlex)
25+
web-services for server-side processing.
2426

25-
* Streaming conversion to CSV (Comma Separated Values) format
26-
* Streaming power spectral density estimation
27-
* Streaming SPICE spacecraft location inclusion
28-
* Streaming SPICE coordinate frame translations
29-
* Writing dasStreams as CDF (Common Data Format) files
27+
Top level XML schema definition for das2 and das3 headers are also kept here.
3028

31-
Doxygen library documentation is available in the [github pages](https://das-developers.github.io/das2C/) for
32-
this repository. To find out more about das2 visit https://das2.org.
29+
To find out more about das2 visit https://das2.org.
3330

3431
## Packages: Anaconda, RPM, etc.
3532

@@ -43,13 +40,6 @@ source miniconda3/bin/activate
4340
conda install -c dasdevelopers das2c
4441
```
4542

46-
For Red Hat/CentOS/Rocky users you can:
47-
```
48-
curl -OJ https://github.com/das-developers/das2C/releases/download/v3.0.0/das2C-2.3.0-1.el8.x86_64.rpm
49-
curl -OJ https://github.com/das-developers/das2C/releases/download/v3.0.0/das2C-devel-2.3.0-1.el8.x86_64.rpm
50-
dnf localinstall das2C*.rpm
51-
```
52-
5343
## Manual build prequisites
5444

5545
Compliation of installation of das2c has been tested on Linux, Windows,
@@ -65,9 +55,7 @@ build libdas2.3:
6555
Though package names vary from system to system, commands for installing the
6656
prequisites are provided below \.\.\.
6757
```bash
68-
$ sudo yum install expat-devel fftw-devel openssl-devel # CentOS 7 and similar
69-
$ sudo yum install python3-devel python36-numpy # CentOS 7 and similar
70-
58+
$ sudo dnf install expat-devel fftw-devel openssl-devel # CentOS 7 and similar
7159
$ sudo apt install libexpat-dev libfftw3-dev libssl-dev zlib1g-dev # Debian 9 and similar
7260
```
7361
and on windows using [vcpkg](https://github.com/microsoft/vcpkg)\.\.\.
@@ -149,26 +137,26 @@ and use the das2 subdirectory in your include statements, for example:
149137
```C
150138
#include <das2/core.h>
151139
```
152-
Common linker arguments for building libdas2.3 dependent applications follow.
140+
Common linker arguments for building libdas dependent applications follow.
153141
For open source programs static linking is perfectly fine:
154142

155143
```make
156-
$(PREFIX)/lib/libdas2.3.a -lexpat -lssl -lcrypto -lz -lm -lpthread # gnu make
144+
$(PREFIX)/lib/libdas3.0.a -lexpat -lssl -lcrypto -lz -lm -lpthread # gnu make
157145

158-
$(INSTALL_PREFIX)/lib/libdas2.3.lib Advapi32.lib User32.lib Crypt32.lib ws2_32.lib # win nmake
146+
$(INSTALL_PREFIX)/lib/libdas3.0.lib Advapi32.lib User32.lib Crypt32.lib ws2_32.lib # win nmake
159147
```
160148

161-
For closed source applications, link against shared das2 objects (i.e. libdas2.3.so
162-
or das2.3.dll) as required by the LGPL:
149+
For closed source applications, link against shared das2 objects (i.e. libdas3.0.so
150+
or das3.0dll) as required by the LGPL:
163151

164152
```make
165153
-L$(PREFIX)/lib -ldas2.3 -lexpat -lssl -lcrypto -lz -lm -lpthread # gnu make
166154

167155
/L $(INSTALL_PREFIX)\bin das2.3.dll das2.3.lib Advapi32.lib User32.lib Crypt32.lib ws2_32.lib # win nmake
168156
```
169157

170-
Note that on Windows, `libdas2.3.lib` is the full static library but the file
171-
`das2.3.lib` is merely a DLL import library.
158+
Note that on Windows, `libdas3.0lib` is the full static library but the file
159+
`das3.0.lib` is merely a DLL import library.
172160

173161

174162
## Building with XMake

0 commit comments

Comments
 (0)